avatax 20.1.0 → 20.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +180 -116
  3. data/lib/avatax/client/addresses.rb +34 -34
  4. data/lib/avatax/client/advancedrules.rb +33 -142
  5. data/lib/avatax/client/avafileforms.rb +37 -37
  6. data/lib/avatax/client/batches.rb +122 -122
  7. data/lib/avatax/client/certexpressinvites.rb +70 -70
  8. data/lib/avatax/client/certificates.rb +313 -313
  9. data/lib/avatax/client/companies.rb +234 -232
  10. data/lib/avatax/client/compliance.rb +2 -2
  11. data/lib/avatax/client/contacts.rb +58 -58
  12. data/lib/avatax/client/customers.rb +279 -279
  13. data/lib/avatax/client/datasources.rb +51 -51
  14. data/lib/avatax/client/definitions.rb +448 -435
  15. data/lib/avatax/client/distancethresholds.rb +74 -74
  16. data/lib/avatax/client/filingcalendars.rb +10 -498
  17. data/lib/avatax/client/filings.rb +13 -13
  18. data/lib/avatax/client/firmclientlinkages.rb +54 -54
  19. data/lib/avatax/client/free.rb +73 -73
  20. data/lib/avatax/client/fundingrequests.rb +32 -32
  21. data/lib/avatax/client/items.rb +284 -284
  22. data/lib/avatax/client/jurisdictionoverrides.rb +70 -70
  23. data/lib/avatax/client/locations.rb +87 -84
  24. data/lib/avatax/client/multidocument.rb +294 -234
  25. data/lib/avatax/client/nexus.rb +283 -143
  26. data/lib/avatax/client/notifications.rb +48 -48
  27. data/lib/avatax/client/provisioning.rb +29 -29
  28. data/lib/avatax/client/registrar.rb +122 -122
  29. data/lib/avatax/client/reports.rb +63 -63
  30. data/lib/avatax/client/settings.rb +108 -108
  31. data/lib/avatax/client/subscriptions.rb +35 -35
  32. data/lib/avatax/client/taxcodes.rb +72 -72
  33. data/lib/avatax/client/taxcontent.rb +106 -106
  34. data/lib/avatax/client/taxrules.rb +122 -122
  35. data/lib/avatax/client/transactions.rb +654 -639
  36. data/lib/avatax/client/upcs.rb +63 -63
  37. data/lib/avatax/client/users.rb +121 -121
  38. data/lib/avatax/client/utilities.rb +34 -34
  39. data/lib/avatax/connection.rb +1 -1
  40. data/lib/avatax/request.rb +2 -0
  41. data/lib/avatax/version.rb +1 -1
  42. metadata +3 -3
@@ -5,116 +5,116 @@ module AvaTax
5
5
 
6
6
  # Create one or more DistanceThreshold objects
7
7
  #
8
- # Create one or more DistanceThreshold objects for this company.
9
- #
10
- # A company-distance-threshold model indicates the distance between a company
11
- # and the taxing borders of various countries. Distance thresholds are necessary
12
- # to correctly calculate some value-added taxes.
13
- #
14
- # ### Security Policies
15
- #
8
+ # Create one or more DistanceThreshold objects for this company.
9
+ #
10
+ # A company-distance-threshold model indicates the distance between a company
11
+ # and the taxing borders of various countries. Distance thresholds are necessary
12
+ # to correctly calculate some value-added taxes.
13
+ #
14
+ # ### Security Policies
15
+ #
16
16
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
17
- # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
18
- # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
17
+ # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
18
+ # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
19
19
  # @return [CompanyDistanceThresholdModel[]]
20
20
  def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
21
21
  post(path, model) end
22
22
 
23
23
  # Delete a single DistanceThreshold object
24
24
  #
25
- # Marks the DistanceThreshold object identified by this URL as deleted.
26
- #
27
- # A company-distance-threshold model indicates the distance between a company
28
- # and the taxing borders of various countries. Distance thresholds are necessary
29
- # to correctly calculate some value-added taxes.
30
- #
31
- # ### Security Policies
32
- #
25
+ # Marks the DistanceThreshold object identified by this URL as deleted.
26
+ #
27
+ # A company-distance-threshold model indicates the distance between a company
28
+ # and the taxing borders of various countries. Distance thresholds are necessary
29
+ # to correctly calculate some value-added taxes.
30
+ #
31
+ # ### Security Policies
32
+ #
33
33
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
34
- # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
35
- # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
34
+ # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
35
+ # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
36
36
  # @return [ErrorDetail[]]
37
37
  def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
38
38
  delete(path) end
39
39
 
40
40
  # Retrieve a single DistanceThreshold
41
41
  #
42
- # Retrieves a single DistanceThreshold object defined by this URL.
43
- #
44
- # A company-distance-threshold model indicates the distance between a company
45
- # and the taxing borders of various countries. Distance thresholds are necessary
46
- # to correctly calculate some value-added taxes.
47
- #
48
- # ### Security Policies
49
- #
42
+ # Retrieves a single DistanceThreshold object defined by this URL.
43
+ #
44
+ # A company-distance-threshold model indicates the distance between a company
45
+ # and the taxing borders of various countries. Distance thresholds are necessary
46
+ # to correctly calculate some value-added taxes.
47
+ #
48
+ # ### Security Policies
49
+ #
50
50
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
51
- # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
52
- # @param id [Integer] The unique ID number referring to this DistanceThreshold object
51
+ # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
52
+ # @param id [Integer] The unique ID number referring to this DistanceThreshold object
53
53
  # @return [Object]
54
54
  def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
55
55
  get(path) end
56
56
 
57
57
  # Retrieve all DistanceThresholds for this company.
58
58
  #
59
- # Lists all DistanceThreshold objects that belong to this company.
60
- #
61
- # A company-distance-threshold model indicates the distance between a company
62
- # and the taxing borders of various countries. Distance thresholds are necessary
63
- # to correctly calculate some value-added taxes.
64
- #
65
- # ### Security Policies
66
- #
59
+ # Lists all DistanceThreshold objects that belong to this company.
60
+ #
61
+ # A company-distance-threshold model indicates the distance between a company
62
+ # and the taxing borders of various countries. Distance thresholds are necessary
63
+ # to correctly calculate some value-added taxes.
64
+ #
65
+ # ### Security Policies
66
+ #
67
67
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
68
- # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
69
- # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
70
- # @param include [String] A comma separated list of additional data to retrieve.
71
- # @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.
72
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
73
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
68
+ # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
69
+ # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
70
+ # @param include [String] A comma separated list of additional data to retrieve.
71
+ # @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.
72
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
73
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
74
74
  # @return [FetchResult]
75
75
  def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
76
76
  get(path, options) end
77
77
 
78
78
  # Retrieve all DistanceThreshold objects
79
79
  #
80
- # Lists all DistanceThreshold objects that belong to this account.
81
- #
82
- # A company-distance-threshold model indicates the distance between a company
83
- # and the taxing borders of various countries. Distance thresholds are necessary
84
- # to correctly calculate some value-added taxes.
85
- #
86
- # 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/) .
87
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
88
- #
89
- # ### Security Policies
90
- #
80
+ # Lists all DistanceThreshold objects that belong to this account.
81
+ #
82
+ # A company-distance-threshold model indicates the distance between a company
83
+ # and the taxing borders of various countries. Distance thresholds are necessary
84
+ # to correctly calculate some value-added taxes.
85
+ #
86
+ # 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/) .
87
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
88
+ #
89
+ # ### Security Policies
90
+ #
91
91
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
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/).
93
- # @param include [String] A comma separated list of additional data to retrieve.
94
- # @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
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
96
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
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/).
93
+ # @param include [String] A comma separated list of additional data to retrieve.
94
+ # @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
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
96
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
97
97
  # @return [FetchResult]
98
98
  def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
99
99
  get(path, options) end
100
100
 
101
101
  # Update a DistanceThreshold object
102
102
  #
103
- # Replace the existing DistanceThreshold object at this URL with an updated object.
104
- #
105
- # A company-distance-threshold model indicates the distance between a company
106
- # and the taxing borders of various countries. Distance thresholds are necessary
107
- # to correctly calculate some value-added taxes.
108
- #
109
- # All data from the existing object will be replaced with data in the object you PUT.
110
- # 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.
111
- #
112
- # ### Security Policies
113
- #
103
+ # Replace the existing DistanceThreshold object at this URL with an updated object.
104
+ #
105
+ # A company-distance-threshold model indicates the distance between a company
106
+ # and the taxing borders of various countries. Distance thresholds are necessary
107
+ # to correctly calculate some value-added taxes.
108
+ #
109
+ # All data from the existing object will be replaced with data in the object you PUT.
110
+ # 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.
111
+ #
112
+ # ### Security Policies
113
+ #
114
114
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
115
- # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
116
- # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
117
- # @param model [Object] The new DistanceThreshold object to store.
115
+ # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
116
+ # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
117
+ # @param model [Object] The new DistanceThreshold object to store.
118
118
  # @return [Object]
119
119
  def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
120
120
  put(path, model) end
@@ -3,507 +3,19 @@ module AvaTax
3
3
  module FilingCalendars
4
4
 
5
5
 
6
- # Checks to see if the company has a valid POA for a tax form code
7
- #
8
- # This API is available by invitation only.
9
- #
10
- # This API fetches valid POA's for a company by TaxFormCode or by country/region
11
- #
12
- # ### Security Policies
13
- #
14
- # * 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.
15
- # * 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.
16
- # * This API is available by invitation only.
17
- # @param companyId [Integer] The company id that we are checking about
18
- # @param taxFormCode [String] The tax form code that we are checking
19
- # @param country [String] The country we are fetching POAs for
20
- # @param region [String] The region we are fetching POAs for
21
- # @return [PowerOfAttorneyCheckModel[]]
22
- def active_power_of_attorney(companyId, options={})
23
- path = "/api/v2/companies/#{companyId}/filingcalendars/powerofattorney"
24
- get(path, options)
25
- end
26
-
27
-
28
- # Approve existing Filing Request
29
- #
30
- # This API is available by invitation only.
31
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
32
- # are reviewed and validated by Avalara Compliance before being implemented.
33
- # The filing request must be in the "ChangeRequest" status to be approved.
34
- #
35
- # ### Security Policies
36
- #
37
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
38
- # * 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.
39
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
40
- # @param companyId [Integer] The unique ID of the company that owns the filing request object
41
- # @param id [Integer] The unique ID of the filing request object
42
- # @return [Object]
43
- def approve_filing_request(companyId, id)
44
- path = "/api/v2/companies/#{companyId}/filingrequests/#{id}/approve"
45
- post(path)
46
- end
47
-
48
-
49
- # Cancel existing Filing Request
50
- #
51
- # This API is available by invitation only.
52
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
53
- # are reviewed and validated by Avalara Compliance before being implemented.
54
- #
55
- # ### Security Policies
56
- #
57
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
58
- # * 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.
59
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
60
- # @param companyId [Integer] The unique ID of the company that owns the filing request object
61
- # @param id [Integer] The unique ID of the filing request object
62
- # @return [Object]
63
- def cancel_filing_request(companyId, id)
64
- path = "/api/v2/companies/#{companyId}/filingrequests/#{id}/cancel"
65
- post(path)
66
- end
67
-
68
-
69
- # Create a new filing request to cancel a filing calendar
70
- #
71
- # This API is available by invitation only.
72
- #
73
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
74
- # are reviewed and validated by Avalara Compliance before being implemented.
75
- #
76
- # ### Security Policies
77
- #
78
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
79
- # * 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.
80
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
81
- # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
82
- # @param id [Integer] The unique ID number of the filing calendar to cancel
83
- # @param model [FilingRequestModel[]] The cancellation request for this filing calendar
84
- # @return [Object]
85
- def cancel_filing_requests(companyId, id, model)
86
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/cancel/request"
87
- post(path, model)
88
- end
89
-
90
-
91
- # Create a filing calendar
92
- #
93
- # This API is available by invitation only and only available for users with Compliance access
94
- # A "filing request" represents information that compliance uses to file a return
95
- #
96
- # ### Security Policies
6
+ # Delete a company return setting
97
7
  #
8
+ # This API is available by invitation only and only available for users with Compliance access
9
+ #
10
+ # ### Security Policies
11
+ #
98
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.
99
- # * 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.
100
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
101
- # @param companyId [Integer] The unique ID of the company that will add the new filing calendar
102
- # @param model [FilingCalendarModel[]] Filing calendars that will be added
103
- # @return [FilingCalendarModel[]]
104
- def create_filing_calendars(companyId, model)
105
- path = "/api/v2/companies/#{companyId}/filingcalendars"
106
- post(path, model)
107
- end
108
-
109
-
110
- # Create a new filing request to create a filing calendar
111
- #
112
- # This API is available by invitation only.
113
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
114
- # are reviewed and validated by Avalara Compliance before being implemented.
115
- #
116
- # ### Security Policies
117
- #
118
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
119
- # * 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.
120
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
121
- # @param companyId [Integer] The unique ID of the company that will add the new filing calendar
122
- # @param model [FilingRequestModel[]] Information about the proposed new filing calendar
123
- # @return [FilingRequestModel[]]
124
- def create_filing_requests(companyId, model)
125
- path = "/api/v2/companies/#{companyId}/filingcalendars/add/request"
126
- post(path, model)
127
- end
128
-
129
-
130
- # Create a company return setting
131
- #
132
- # This API is available by invitation only and only available for users with Compliance access
133
- #
134
- # ### Security Policies
135
- #
136
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
137
- # @param companyId [Integer] The unique ID of the company that will add the new filing calendar
138
- # @param filingCalendarId [Integer] The unique ID of the filing calendar that will add the new filing calendar setting
139
- # @param model [CompanyReturnSettingModel[]] CompanyReturnSettings that will be added
13
+ # @param companyId [Integer] The unique ID of the company
14
+ # @param filingCalendarId [Integer] The unique ID of the filing calendar that will remove setting
15
+ # @param companyReturnSettingId [Integer] The unique ID of the company return setting that will be deleted from the filing calendar
140
16
  # @return [CompanyReturnSettingModel[]]
141
- def create_update_company_return_settings(companyId, filingCalendarId, model)
142
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/settings"
143
- post(path, model)
144
- end
145
-
146
-
147
- # Returns a list of options for adding the specified form.
148
- #
149
- # This API is available by invitation only.
150
- #
151
- # ### Security Policies
152
- #
153
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
154
- # * 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.
155
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
156
- # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
157
- # @param formCode [String] The unique code of the form
158
- # @return [CycleAddOptionModel[]]
159
- def cycle_safe_add(companyId, options={})
160
- path = "/api/v2/companies/#{companyId}/filingcalendars/add/options"
161
- get(path, options)
162
- end
163
-
164
-
165
- # Indicates when changes are allowed to be made to a filing calendar.
166
- #
167
- # This API is available by invitation only.
168
- #
169
- # ### Security Policies
170
- #
171
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
172
- # * 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.
173
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
174
- # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
175
- # @param id [Integer] The unique ID of the filing calendar object
176
- # @param model [FilingCalendarEditModel[]] A list of filing calendar edits to be made
177
- # @return [Object]
178
- def cycle_safe_edit(companyId, id, model)
179
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/options"
180
- post(path, model)
181
- end
182
-
183
-
184
- # Returns a list of options for expiring a filing calendar
185
- #
186
- # This API is available by invitation only.
187
- #
188
- # ### Security Policies
189
- #
190
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
191
- # * 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.
192
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
193
- # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
194
- # @param id [Integer] The unique ID of the filing calendar object
195
- # @return [Object]
196
- def cycle_safe_expiration(companyId, id)
197
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/cancel/options"
198
- get(path)
199
- end
200
-
201
-
202
- # Delete a single filing calendar.
203
- #
204
- # This API is available by invitation only.
205
- # Mark the existing notice object at this URL as deleted.
206
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
207
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
208
- #
209
- # ### Security Policies
210
- #
211
- # * 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.
212
- # * 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.
213
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
214
- # @param companyId [Integer] The ID of the company that owns this filing calendar.
215
- # @param id [Integer] The ID of the filing calendar you wish to delete.
216
- # @return [ErrorDetail[]]
217
- def delete_filing_calendar(companyId, id)
218
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
219
- delete(path)
220
- end
221
-
222
-
223
- # Retrieve a single filing calendar
224
- #
225
- # This API is available by invitation only.
226
- #
227
- # ### Security Policies
228
- #
229
- # * 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.
230
- # * 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.
231
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
232
- # @param companyId [Integer] The ID of the company that owns this filing calendar
233
- # @param id [Integer] The primary key of this filing calendar
234
- # @return [Object]
235
- def get_filing_calendar(companyId, id)
236
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
237
- get(path)
238
- end
239
-
240
-
241
- # Retrieve a single filing request
242
- #
243
- # This API is available by invitation only.
244
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
245
- # are reviewed and validated by Avalara Compliance before being implemented.
246
- #
247
- # ### Security Policies
248
- #
249
- # * 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.
250
- # * 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.
251
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
252
- # @param companyId [Integer] The ID of the company that owns this filing calendar
253
- # @param id [Integer] The primary key of this filing calendar
254
- # @return [Object]
255
- def get_filing_request(companyId, id)
256
- path = "/api/v2/companies/#{companyId}/filingrequests/#{id}"
257
- get(path)
258
- end
259
-
260
-
261
- # Retrieve all filing calendars for this company
262
- #
263
- # This API is available by invitation only.
264
- #
265
- # ### Security Policies
266
- #
267
- # * 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.
268
- # * 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.
269
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
270
- # @param companyId [Integer] The ID of the company that owns these batches
271
- # @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
272
- # @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.
273
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
274
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
275
- # @param returnCountry [String] A comma separated list of countries
276
- # @param returnRegion [String] A comma separated list of regions
277
- # @return [FetchResult]
278
- def list_filing_calendars(companyId, options={})
279
- path = "/api/v2/companies/#{companyId}/filingcalendars"
280
- get(path, options)
281
- end
282
-
283
-
284
- # Retrieve all filing requests for this company
285
- #
286
- # This API is available by invitation only.
287
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
288
- # are reviewed and validated by Avalara Compliance before being implemented.
289
- #
290
- # ### Security Policies
291
- #
292
- # * 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.
293
- # * 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.
294
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
295
- # @param companyId [Integer] The ID of the company that owns these batches
296
- # @param filingCalendarId [Integer] Specific filing calendar id for the request
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/).
298
- # @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.
299
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
300
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
301
- # @return [FetchResult]
302
- def list_filing_requests(companyId, options={})
303
- path = "/api/v2/companies/#{companyId}/filingrequests"
304
- get(path, options)
305
- end
306
-
307
-
308
- # New request for getting for validating customer's login credentials
309
- #
310
- # This API is available by invitation only.
311
- #
312
- # This API verifies that a customer has submitted correct login credentials for a tax authority's online filing system.
313
- #
314
- # ### Security Policies
315
- #
316
- # * 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.
317
- # * 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.
318
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
319
- # @param model [Object] The model of the login information we are verifying
320
- # @return [Object]
321
- def login_verification_request(model)
322
- path = "/api/v2/filingcalendars/credentials/verify"
323
- post(path, model)
324
- end
325
-
326
-
327
- # Gets the request status and Login Result
328
- #
329
- # This API is available by invitation only.
330
- #
331
- # This API checks the status of a login verification request. It may only be called by authorized users from the account
332
- # that initially requested the login verification.
333
- #
334
- # ### Security Policies
335
- #
336
- # * 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.
337
- # * 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.
338
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
339
- # @param jobId [Integer] The unique ID number of this login request
340
- # @return [Object]
341
- def login_verification_status(jobId)
342
- path = "/api/v2/filingcalendars/credentials/#{jobId}"
343
- get(path)
344
- end
345
-
346
-
347
- # Retrieve all filing calendars
348
- #
349
- # This API is available by invitation only.
350
- #
351
- # This API is deprecated - please use POST `/api/v2/filingrequests/query` API.
352
- #
353
- # ### Security Policies
354
- #
355
- # * 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.
356
- # * 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.
357
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
358
- # @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
359
- # @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.
360
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
361
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
362
- # @param returnCountry [String] If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes.
363
- # @param returnRegion [String] If specified, fetches only filing calendars that apply to tax filings in this specific region. Uses ISO 3166 region codes.
364
- # @return [FetchResult]
365
- def query_filing_calendars(options={})
366
- path = "/api/v2/filingcalendars"
367
- get(path, options)
368
- end
369
-
370
-
371
- # Retrieve all filing calendars
372
- #
373
- # This API is available by invitation only.
374
- #
375
- # This API is intended to replace the GET `/api/v2/filingcalendars` 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.
376
- # The documentation of the GET API shows how filtering, sorting and pagination works.
377
- #
378
- # ### Security Policies
379
- #
380
- # * 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.
381
- # * 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.
382
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
383
- # @param returnCountry [String] If specified, fetches only filing calendars that apply to tax filings in this specific country. Uses ISO 3166 country codes.
384
- # @param returnRegion [String] If specified, fetches only filing calendars that apply to tax filings in this specific region. Uses ISO 3166 region codes.
385
- # @param model [Object] Query object to filter, sort and paginate the filing calendars.
386
- # @return [FetchResult]
387
- def query_filing_calendars_post(model, options={})
388
- path = "/api/v2/filingcalendars/query"
389
- post(path, model, options)
390
- end
391
-
392
-
393
- # Retrieve all filing requests
394
- #
395
- # This API is available by invitation only.
396
- #
397
- # This API is deprecated - please use POST `/api/v2/filingrequests/query` API.
398
- #
399
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
400
- # are reviewed and validated by Avalara Compliance before being implemented.
401
- #
402
- # 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/) .
403
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
404
- #
405
- # ### Security Policies
406
- #
407
- # * 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.
408
- # * 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.
409
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
410
- # @param filingCalendarId [Integer] Specific filing calendar id for the request
411
- # @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/).
412
- # @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.
413
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
414
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
415
- # @return [FetchResult]
416
- def query_filing_requests(options={})
417
- path = "/api/v2/filingrequests"
418
- get(path, options)
419
- end
420
-
421
-
422
- # Retrieve all filing requests
423
- #
424
- # This API is available by invitation only.
425
- #
426
- # This API is intended to replace the GET `/api/v2/filingrequests` 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.
427
- # The documentation of the GET API shows how filtering, sorting and pagination works.
428
- #
429
- # ### Security Policies
430
- #
431
- # * 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.
432
- # * 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.
433
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
434
- # @param filingCalendarId [Integer] Specific filing calendar id for the request
435
- # @param model [Object] Query object to filter, sort and paginate the filing calendars.
436
- # @return [FetchResult]
437
- def query_filing_requests_post(model, options={})
438
- path = "/api/v2/filingrequests/query"
439
- post(path, model, options)
440
- end
441
-
442
-
443
- # Create a new filing request to edit a filing calendar
444
- #
445
- # This API is available by invitation only.
446
- #
447
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
448
- # are reviewed and validated by Avalara Compliance before being implemented.
449
- #
450
- # Certain users may not update filing calendars directly. Instead, they may submit an edit request
451
- # to modify the value of a filing calendar using this API.
452
- #
453
- # ### Security Policies
454
- #
455
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
456
- # * 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.
457
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
458
- # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
459
- # @param id [Integer] The unique ID number of the filing calendar to edit
460
- # @param model [FilingRequestModel[]] A list of filing calendar edits to be made
461
- # @return [Object]
462
- def request_filing_calendar_update(companyId, id, model)
463
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}/edit/request"
464
- post(path, model)
465
- end
466
-
467
-
468
- # Edit existing Filing Calendar
469
- #
470
- # This API is available by invitation only.
471
- #
472
- # ### Security Policies
473
- #
474
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
475
- # * 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.
476
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
477
- # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
478
- # @param id [Integer] The unique ID of the filing calendar object
479
- # @param model [Object] The filing calendar model you are wishing to update with.
480
- # @return [Object]
481
- def update_filing_calendar(companyId, id, model)
482
- path = "/api/v2/companies/#{companyId}/filingcalendars/#{id}"
483
- put(path, model)
484
- end
485
-
486
-
487
- # Edit existing Filing Request
488
- #
489
- # This API is available by invitation only.
490
- # A "filing request" represents a request to change an existing filing calendar. Filing requests
491
- # are reviewed and validated by Avalara Compliance before being implemented.
492
- #
493
- # ### Security Policies
494
- #
495
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
496
- # * 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.
497
- # * This API is available by invitation only.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
498
- # @param companyId [Integer] The unique ID of the company that owns the filing request object
499
- # @param id [Integer] The unique ID of the filing request object
500
- # @param model [Object] A list of filing calendar edits to be made
501
- # @return [Object]
502
- def update_filing_request(companyId, id, model)
503
- path = "/api/v2/companies/#{companyId}/filingrequests/#{id}"
504
- put(path, model)
505
- end
506
-
17
+ def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId) path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
18
+ delete(path) end
507
19
  end
508
20
  end
509
21
  end