avatax 21.7.1 → 21.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +94 -83
  3. data/lib/avatax/client/addresses.rb +22 -20
  4. data/lib/avatax/client/advancedrules.rb +46 -41
  5. data/lib/avatax/client/ageverification.rb +29 -0
  6. data/lib/avatax/client/avafileforms.rb +46 -41
  7. data/lib/avatax/client/batches.rb +70 -62
  8. data/lib/avatax/client/certexpressinvites.rb +30 -27
  9. data/lib/avatax/client/certificates.rb +126 -111
  10. data/lib/avatax/client/companies.rb +174 -153
  11. data/lib/avatax/client/compliance.rb +25 -14
  12. data/lib/avatax/client/contacts.rb +54 -48
  13. data/lib/avatax/client/customers.rb +110 -97
  14. data/lib/avatax/client/datasources.rb +54 -48
  15. data/lib/avatax/client/definitions.rb +624 -450
  16. data/lib/avatax/client/distancethresholds.rb +54 -48
  17. data/lib/avatax/client/ecommercetoken.rb +20 -18
  18. data/lib/avatax/client/filingcalendars.rb +44 -20
  19. data/lib/avatax/client/filings.rb +24 -20
  20. data/lib/avatax/client/firmclientlinkages.rb +78 -69
  21. data/lib/avatax/client/free.rb +14 -13
  22. data/lib/avatax/client/fundingrequests.rb +22 -20
  23. data/lib/avatax/client/items.rb +209 -181
  24. data/lib/avatax/client/jurisdictionoverrides.rb +54 -48
  25. data/lib/avatax/client/locations.rb +102 -90
  26. data/lib/avatax/client/multidocument.rb +86 -76
  27. data/lib/avatax/client/nexus.rb +148 -105
  28. data/lib/avatax/client/notices.rb +30 -26
  29. data/lib/avatax/client/notifications.rb +30 -27
  30. data/lib/avatax/client/provisioning.rb +22 -20
  31. data/lib/avatax/client/registrar.rb +94 -83
  32. data/lib/avatax/client/reports.rb +38 -34
  33. data/lib/avatax/client/settings.rb +54 -48
  34. data/lib/avatax/client/shippingverification.rb +66 -0
  35. data/lib/avatax/client/subscriptions.rb +30 -27
  36. data/lib/avatax/client/taxcodes.rb +54 -48
  37. data/lib/avatax/client/taxcontent.rb +46 -41
  38. data/lib/avatax/client/taxrules.rb +56 -50
  39. data/lib/avatax/client/transactions.rb +174 -153
  40. data/lib/avatax/client/upcs.rb +54 -48
  41. data/lib/avatax/client/userdefinedfields.rb +52 -0
  42. data/lib/avatax/client/users.rb +70 -62
  43. data/lib/avatax/client/utilities.rb +30 -27
  44. data/lib/avatax/client.rb +2 -0
  45. data/lib/avatax/connection.rb +1 -1
  46. data/lib/avatax/request.rb +21 -12
  47. data/lib/avatax/version.rb +1 -1
  48. metadata +6 -3
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module DistanceThresholds
4
-
5
-
6
- # Create one or more DistanceThreshold objects
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module DistanceThresholds
4
+
5
+
6
+ # Create one or more DistanceThreshold objects
7
+ #
8
8
  # Create one or more DistanceThreshold objects for this company.
9
9
  #
10
10
  # A company-distance-threshold model indicates the distance between a company
@@ -13,15 +13,16 @@ module AvaTax
13
13
  #
14
14
  # ### Security Policies
15
15
  #
16
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [CompanyDistanceThresholdModel[]]
20
- def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
21
- post(path, model) end
22
-
23
- # Delete a single DistanceThreshold object
24
- #
20
+ # @return [CompanyDistanceThresholdModel[]]
21
+ def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
22
+ post(path, model, {}, "21.12.0") end
23
+
24
+ # Delete a single DistanceThreshold object
25
+ #
25
26
  # Marks the DistanceThreshold object identified by this URL as deleted.
26
27
  #
27
28
  # A company-distance-threshold model indicates the distance between a company
@@ -30,15 +31,16 @@ module AvaTax
30
31
  #
31
32
  # ### Security Policies
32
33
  #
33
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [ErrorDetail[]]
37
- def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
38
- delete(path) end
39
-
40
- # Retrieve a single DistanceThreshold
41
- #
38
+ # @return [ErrorDetail[]]
39
+ def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
40
+ delete(path, {}, "21.12.0") end
41
+
42
+ # Retrieve a single DistanceThreshold
43
+ #
42
44
  # Retrieves a single DistanceThreshold object defined by this URL.
43
45
  #
44
46
  # A company-distance-threshold model indicates the distance between a company
@@ -47,15 +49,16 @@ module AvaTax
47
49
  #
48
50
  # ### Security Policies
49
51
  #
50
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
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
- # @return [Object]
54
- def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
55
- get(path) end
56
-
57
- # Retrieve all DistanceThresholds for this company.
58
- #
56
+ # @return [Object]
57
+ def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
58
+ get(path, {}, "21.12.0") end
59
+
60
+ # Retrieve all DistanceThresholds for this company.
61
+ #
59
62
  # Lists all DistanceThreshold objects that belong to this company.
60
63
  #
61
64
  # A company-distance-threshold model indicates the distance between a company
@@ -64,19 +67,20 @@ module AvaTax
64
67
  #
65
68
  # ### Security Policies
66
69
  #
67
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
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.
71
75
  # @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
76
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
73
77
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
74
- # @return [FetchResult]
75
- def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
76
- get(path, options) end
77
-
78
- # Retrieve all DistanceThreshold objects
79
- #
78
+ # @return [FetchResult]
79
+ def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
80
+ get(path, options, "21.12.0") end
81
+
82
+ # Retrieve all DistanceThreshold objects
83
+ #
80
84
  # Lists all DistanceThreshold objects that belong to this account.
81
85
  #
82
86
  # A company-distance-threshold model indicates the distance between a company
@@ -88,18 +92,19 @@ module AvaTax
88
92
  #
89
93
  # ### Security Policies
90
94
  #
91
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
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.
95
100
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
96
101
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
97
- # @return [FetchResult]
98
- def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
99
- get(path, options) end
100
-
101
- # Update a DistanceThreshold object
102
- #
102
+ # @return [FetchResult]
103
+ def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
104
+ get(path, options, "21.12.0") end
105
+
106
+ # Update a DistanceThreshold object
107
+ #
103
108
  # Replace the existing DistanceThreshold object at this URL with an updated object.
104
109
  #
105
110
  # A company-distance-threshold model indicates the distance between a company
@@ -111,13 +116,14 @@ module AvaTax
111
116
  #
112
117
  # ### Security Policies
113
118
  #
114
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [Object]
119
- def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
120
- put(path, model) end
121
- end
122
- end
124
+ # @return [Object]
125
+ def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
126
+ put(path, model, {}, "21.12.0") end
127
+ end
128
+ end
123
129
  end
@@ -5,33 +5,35 @@ module AvaTax
5
5
 
6
6
  # Create a new eCommerce token.
7
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
- #
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
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]
15
+ # Swagger Name: AvaTaxClient
16
+ # @param companyId [Integer] The company ID that will be issued this certificate.
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, {}, "21.12.0") end
20
21
 
21
22
  # Refresh an eCommerce token.
22
23
  #
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
- #
24
+ # Refresh an eCommerce token.
25
+ #
26
+ # 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.
27
+ #
28
+ # ### Security Policies
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.
30
- # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
31
- # @param model [Object]
31
+ # Swagger Name: AvaTaxClient
32
+ # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
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, {}, "21.12.0") end
35
37
  end
36
38
  end
37
39
  end
@@ -1,36 +1,60 @@
1
- module AvaTax
2
- class Client
3
- module FilingCalendars
4
-
5
-
6
- # Add or Edit options
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module FilingCalendars
4
+
5
+
6
+ # Add or Edit options
7
+ #
8
8
  # Returns a list of options for adding tax forms for the company and tax form code specified.
9
9
  # Returns edit options when modifying a filing calendar.
10
10
  # This API is available by invitation only.
11
11
  #
12
12
  # ### Security Policies
13
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.
14
+ # * This API requires openId bearer token for authentication
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
- # @return [Object]
18
- def cycle_safe_options(companyId, model) path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
19
- post(path, model) end
20
-
21
- # Delete a company return setting
22
- #
19
+ # @return [Object]
20
+ def cycle_safe_options(companyId, model) path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
21
+ post(path, model, {}, "21.12.0") end
22
+
23
+ # Delete a company return setting
24
+ #
23
25
  # This API is available by invitation only and only available for users with Compliance access
24
26
  #
25
27
  # ### Security Policies
26
28
  #
27
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
29
+ # * This API requires openId bearer token for authentication
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
- # @return [CompanyReturnSettingModel[]]
32
- def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId) path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
33
- delete(path) end
34
- end
35
- end
35
+ # @return [CompanyReturnSettingModel[]]
36
+ def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId) path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
37
+ delete(path, {}, "21.12.0") end
38
+
39
+ # Retrieve all legacy filing calendars for this company
40
+ #
41
+ # This API is available by invitation only.
42
+ #
43
+ # ### Security Policies
44
+ #
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.
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
48
+ # @param companyId [Integer] The ID of the company that owns these batches
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
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.
51
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
52
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
53
+ # @param returnCountry [String] A comma separated list of countries
54
+ # @param returnRegion [String] A comma separated list of regions
55
+ # @return [FetchResult]
56
+ def legacy_filing_calendars(companyId, options={}) path = "/api/v2/companies/#{companyId}/filingcalendars/Legacy"
57
+ get(path, options, "21.12.0") end
58
+ end
59
+ end
36
60
  end
@@ -1,26 +1,30 @@
1
- module AvaTax
2
- class Client
3
- module Filings
4
-
5
-
6
- # Retrieve a filing containing the return and all its accrual returns.
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Filings
4
+
5
+
6
+ # Retrieve a filing containing the return and all its accrual returns.
7
+ #
8
8
  # ### Security Policies
9
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.
10
+ # * This API requires openId bearer token for authentication
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
- # @return [FetchResult]
14
- def get_accrual_filings(companyId, filingReturnId) path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
15
- get(path) end
16
-
17
- # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
18
- #
15
+ # @return [FetchResult]
16
+ def get_accrual_filings(companyId, filingReturnId) path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
17
+ get(path, {}, "21.12.0") end
18
+
19
+ # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
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
- # * 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.
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
@@ -30,9 +34,9 @@ module AvaTax
30
34
  # @param region [String] The region of the return(s) you are trying to retrieve
31
35
  # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
32
36
  # @param taxformCode [String] The unique tax form code of the form.
33
- # @return [FetchResult]
34
- def get_filed_returns(companyId, options={}) path = "/api/v2/companies/#{companyId}/filings/returns/filed"
35
- get(path, options) end
36
- end
37
- end
37
+ # @return [FetchResult]
38
+ def get_filed_returns(companyId, options={}) path = "/api/v2/companies/#{companyId}/filings/returns/filed"
39
+ get(path, options, "21.12.0") end
40
+ end
41
+ end
38
42
  end
@@ -1,22 +1,23 @@
1
- module AvaTax
2
- class Client
3
- module FirmClientLinkages
4
-
5
-
6
- # Approves linkage to a firm for a client account
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module FirmClientLinkages
4
+
5
+
6
+ # Approves linkage to a firm for a client account
7
+ #
8
8
  # This API enables the account admin of a client account to approve linkage request by a firm.
9
9
  #
10
10
  # ### Security Policies
11
11
  #
12
- # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [Object]
15
- def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
16
- post(path) end
17
-
18
- # Request a new FirmClient account and create an approved linkage to it
19
- #
15
+ # @return [Object]
16
+ def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
17
+ post(path, {}, "21.12.0") end
18
+
19
+ # Request a new FirmClient account and create an approved linkage to it
20
+ #
20
21
  # This API is for use by Firms only.
21
22
  #
22
23
  # Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
@@ -30,95 +31,103 @@ module AvaTax
30
31
  #
31
32
  # ### Security Policies
32
33
  #
33
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
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
- # @return [Object]
36
- def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
37
- post(path, model) end
38
-
39
- # Links a firm account with the client account
40
- #
37
+ # @return [Object]
38
+ def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
39
+ post(path, model, {}, "21.12.0") end
40
+
41
+ # Links a firm account with the client account
42
+ #
41
43
  # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
42
44
  #
43
45
  # ### Security Policies
44
46
  #
45
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [Object]
48
- def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
49
- post(path, model) end
50
-
51
- # Delete a linkage
52
- #
50
+ # @return [Object]
51
+ def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
52
+ post(path, model, {}, "21.12.0") end
53
+
54
+ # Delete a linkage
55
+ #
53
56
  # This API marks a linkage between a firm and client as deleted.
54
57
  #
55
58
  # ### Security Policies
56
59
  #
57
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [ErrorDetail[]]
60
- def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
61
- delete(path) end
62
-
63
- # Get linkage between a firm and client by id
64
- #
63
+ # @return [ErrorDetail[]]
64
+ def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
65
+ delete(path, {}, "21.12.0") end
66
+
67
+ # Get linkage between a firm and client by id
68
+ #
65
69
  # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
66
70
  #
67
71
  # ### Security Policies
68
72
  #
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.
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
- # @return [Object]
72
- def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
73
- get(path) end
74
-
75
- # List client linkages for a firm or client
76
- #
76
+ # @return [Object]
77
+ def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
78
+ get(path, {}, "21.12.0") end
79
+
80
+ # List client linkages for a firm or client
81
+ #
77
82
  # This API enables the firm or account users to request the associated linkages to the account.
78
83
  #
79
84
  # ### Security Policies
80
85
  #
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.
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
- # @return [FetchResult]
84
- def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
85
- get(path, options) end
86
-
87
- # Rejects linkage to a firm for a client account
88
- #
89
+ # @return [FetchResult]
90
+ def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
91
+ get(path, options, "21.12.0") end
92
+
93
+ # Rejects linkage to a firm for a client account
94
+ #
89
95
  # This API enables the account admin of a client account to reject linkage request by a firm.
90
96
  #
91
97
  # ### Security Policies
92
98
  #
93
- # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [Object]
96
- def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
97
- post(path) end
98
-
99
- # Reset linkage status between a client and firm back to requested
100
- #
102
+ # @return [Object]
103
+ def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
104
+ post(path, {}, "21.12.0") end
105
+
106
+ # Reset linkage status between a client and firm back to requested
107
+ #
101
108
  # This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
102
109
  #
103
110
  # ### Security Policies
104
111
  #
105
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [Object]
108
- def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
109
- post(path) end
110
-
111
- # Revokes previously approved linkage to a firm for a client account
112
- #
115
+ # @return [Object]
116
+ def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
117
+ post(path, {}, "21.12.0") end
118
+
119
+ # Revokes previously approved linkage to a firm for a client account
120
+ #
113
121
  # This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
114
122
  #
115
123
  # ### Security Policies
116
124
  #
117
- # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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
- # @return [Object]
120
- def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
121
- post(path) end
122
- end
123
- end
128
+ # @return [Object]
129
+ def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
130
+ post(path, {}, "21.12.0") end
131
+ end
132
+ end
124
133
  end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Free
4
-
5
-
6
- # FREE API - Request a free trial of AvaTax
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Free
4
+
5
+
6
+ # FREE API - Request a free trial of AvaTax
7
+ #
8
8
  # Call this API to obtain a free AvaTax account.
9
9
  #
10
10
  # This API is free to use. No authentication credentials are required to call this API. You must read and
@@ -18,11 +18,12 @@ module AvaTax
18
18
  #
19
19
  # ### Security Policies
20
20
  #
21
- # * This API may be called without providing authentication credentials.
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
- # @return [Object]
24
- def request_free_trial(model) path = "/api/v2/accounts/freetrials/request"
25
- post(path, model) end
26
- end
27
- end
24
+ # @return [Object]
25
+ def request_free_trial(model) path = "/api/v2/accounts/freetrials/request"
26
+ post(path, model, {}, "21.12.0") end
27
+ end
28
+ end
28
29
  end