You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/avatax/client/addresses.rb
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -12,15 +12,15 @@ module Addresses
12
12
# This is the same API as the POST /api/v2/addresses/resolve endpoint.
13
13
# Both verbs are supported to provide for flexible implementation.
14
14
#
15
-
# Inorder to get any evaluation for an address please provide atleast one of the following fields/pairs:
15
+
# In order to get any evaluation for an address, please provide at least one of the following fields/pairs:
16
16
# 1. postal code
17
17
# 2. line1 + city + region
18
18
# 3. line1 + postal code
19
19
#
20
20
# ### Security Policies
21
21
#
22
22
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
23
-
# * This API depends on the following active services<br />*Required* (all): AutoAddress.
23
+
# * This API depends on the following active services:*Required* (all): AutoAddress.
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
48
-
# * This API depends on the following active services<br />*Required* (all): AutoAddress.
48
+
# * This API depends on the following active services:*Required* (all): AutoAddress.
Copy file name to clipboardExpand all lines: lib/avatax/client/avafileforms.rb
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ module AvaFileForms
11
11
# ### Security Policies
12
12
#
13
13
# * This API requires the user role Compliance Root User.
14
-
# * 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.
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
15
# @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
# * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
27
-
# * 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.
27
+
# * 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.
28
28
# @param id [Integer] The ID of the AvaFileForm you wish to delete.
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
40
-
# * 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.
40
+
# * 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.
41
41
# @param id [Integer] The primary key of this AvaFileForm
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
54
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
54
+
# * 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.
55
55
# @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:* outletTypeId
56
56
# @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.
57
57
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
# * This API requires the user role Compliance Root User.
71
-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
71
+
# * 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.
72
72
# @param id [Integer] The ID of the AvaFileForm you wish to update
73
73
# @param model [Object] The AvaFileForm model you wish to update.
Copy file name to clipboardExpand all lines: lib/avatax/client/certexpressinvites.rb
+15-15Lines changed: 15 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -16,15 +16,15 @@ module CertExpressInvites
16
16
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
17
17
# your company so that they can be used for tax exemptions.
18
18
#
19
-
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
20
-
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
21
-
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
22
-
# storage for this company, call `RequestCertificateSetup`.
19
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
20
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
21
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
22
+
# certificate storage for this company, call `RequestCertificateSetup`.
23
23
#
24
24
# ### Security Policies
25
25
#
26
26
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
27
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
27
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
28
28
# @param companyId [Integer] The unique ID number of the company that will record certificates
29
29
# @param customerCode [String] The number of the customer where the request is sent to
30
30
# @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
46
46
# your company so that they can be used for tax exemptions.
47
47
#
48
-
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
49
-
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
50
-
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
51
-
# storage for this company, call `RequestCertificateSetup`.
48
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
49
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
50
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
51
+
# certificate storage for this company, call `RequestCertificateSetup`.
52
52
#
53
53
# ### Security Policies
54
54
#
55
55
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
56
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
56
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
57
57
# @param companyId [Integer] The unique ID number of the company that issued this invitation
58
58
# @param customerCode [String] The number of the customer where the request is sent to
59
59
# @param id [Integer] The unique ID number of this CertExpress invitation
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
76
76
# your company so that they can be used for tax exemptions.
77
77
#
78
-
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
79
-
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
80
-
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
81
-
# storage for this company, call `RequestCertificateSetup`.
78
+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
79
+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
80
+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
81
+
# certificate storage for this company, call `RequestCertificateSetup`.
82
82
#
83
83
# ### Security Policies
84
84
#
85
85
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
86
-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
86
+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
87
87
# @param companyId [Integer] The unique ID number of the company that issued this invitation
88
88
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
89
89
# @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, customer, coverLetter, exposureZones, exemptReasons, requestLink
0 commit comments