avatax 20.5.0 → 20.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.vs/slnx.sqlite +0 -0
  3. data/avatax.gemspec +0 -1
  4. data/lib/avatax/client/accounts.rb +83 -83
  5. data/lib/avatax/client/addresses.rb +21 -21
  6. data/lib/avatax/client/advancedrules.rb +51 -41
  7. data/lib/avatax/client/avafileforms.rb +41 -41
  8. data/lib/avatax/client/batches.rb +101 -48
  9. data/lib/avatax/client/certexpressinvites.rb +39 -39
  10. data/lib/avatax/client/certificates.rb +163 -163
  11. data/lib/avatax/client/companies.rb +226 -121
  12. data/lib/avatax/client/compliance.rb +13 -13
  13. data/lib/avatax/client/contacts.rb +48 -48
  14. data/lib/avatax/client/customers.rb +145 -145
  15. data/lib/avatax/client/datasources.rb +48 -48
  16. data/lib/avatax/client/definitions.rb +422 -420
  17. data/lib/avatax/client/distancethresholds.rb +48 -48
  18. data/lib/avatax/client/ecms.rb +26 -31
  19. data/lib/avatax/client/ecommercetoken.rb +37 -0
  20. data/lib/avatax/client/errortransactions.rb +27 -15
  21. data/lib/avatax/client/filingcalendars.rb +28 -13
  22. data/lib/avatax/client/filings.rb +25 -14
  23. data/lib/avatax/client/firmclientlinkages.rb +69 -69
  24. data/lib/avatax/client/free.rb +27 -27
  25. data/lib/avatax/client/fundingrequests.rb +20 -20
  26. data/lib/avatax/client/items.rb +139 -139
  27. data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
  28. data/lib/avatax/client/locations.rb +168 -57
  29. data/lib/avatax/client/multidocument.rb +98 -78
  30. data/lib/avatax/client/nexus.rb +104 -104
  31. data/lib/avatax/client/notices.rb +47 -139
  32. data/lib/avatax/client/notifications.rb +27 -27
  33. data/lib/avatax/client/provisioning.rb +20 -20
  34. data/lib/avatax/client/registrar.rb +76 -76
  35. data/lib/avatax/client/reports.rb +34 -34
  36. data/lib/avatax/client/settings.rb +48 -48
  37. data/lib/avatax/client/subscriptions.rb +27 -27
  38. data/lib/avatax/client/taxcodes.rb +48 -48
  39. data/lib/avatax/client/taxcontent.rb +27 -27
  40. data/lib/avatax/client/taxprofiles.rb +14 -10
  41. data/lib/avatax/client/taxrules.rb +48 -48
  42. data/lib/avatax/client/transactions.rb +185 -155
  43. data/lib/avatax/client/upcs.rb +48 -48
  44. data/lib/avatax/client/users.rb +62 -62
  45. data/lib/avatax/client/utilities.rb +27 -27
  46. data/lib/avatax/connection.rb +2 -2
  47. data/lib/avatax/version.rb +1 -1
  48. metadata +3 -16
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module JurisdictionOverrides
4
-
5
-
6
- # Create one or more overrides
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module JurisdictionOverrides
4
+
5
+
6
+ # Create one or more overrides
7
+ #
8
8
  # Creates one or more jurisdiction override objects for this account.
9
9
  #
10
10
  # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -14,28 +14,28 @@ module AvaTax
14
14
  #
15
15
  # ### Security Policies
16
16
  #
17
- # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
17
+ # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
18
18
  # @param accountId [Integer] The ID of the account that owns this override
19
19
  # @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
20
- # @return [JurisdictionOverrideModel[]]
21
- def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
22
- post(path, model) end
23
-
24
- # Delete a single override
25
- #
20
+ # @return [JurisdictionOverrideModel[]]
21
+ def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
22
+ post(path, model) end
23
+
24
+ # Delete a single override
25
+ #
26
26
  # Marks the item object at this URL as deleted.
27
27
  #
28
28
  # ### Security Policies
29
29
  #
30
- # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
30
+ # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
31
31
  # @param accountId [Integer] The ID of the account that owns this override
32
32
  # @param id [Integer] The ID of the override you wish to delete
33
- # @return [ErrorDetail[]]
34
- def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
35
- delete(path) end
36
-
37
- # Retrieve a single override
38
- #
33
+ # @return [ErrorDetail[]]
34
+ def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
35
+ delete(path) end
36
+
37
+ # Retrieve a single override
38
+ #
39
39
  # Get the item object identified by this URL.
40
40
  #
41
41
  # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -45,15 +45,15 @@ module AvaTax
45
45
  #
46
46
  # ### Security Policies
47
47
  #
48
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
48
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
49
49
  # @param accountId [Integer] The ID of the account that owns this override
50
50
  # @param id [Integer] The primary key of this override
51
- # @return [Object]
52
- def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
53
- get(path) end
54
-
55
- # Retrieve overrides for this account
56
- #
51
+ # @return [Object]
52
+ def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
53
+ get(path) end
54
+
55
+ # Retrieve overrides for this account
56
+ #
57
57
  # List all jurisdiction override objects defined for this account.
58
58
  #
59
59
  # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -66,19 +66,19 @@ module AvaTax
66
66
  #
67
67
  # ### Security Policies
68
68
  #
69
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
69
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
70
70
  # @param accountId [Integer] The ID of the account that owns this override
71
71
  # @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:* country, Jurisdictions
72
72
  # @param include [String] A comma separated list of additional data to retrieve.
73
73
  # @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.
74
74
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
75
75
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
76
- # @return [FetchResult]
77
- def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
78
- get(path, options) end
79
-
80
- # Retrieve all overrides
81
- #
76
+ # @return [FetchResult]
77
+ def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
78
+ get(path, options) end
79
+
80
+ # Retrieve all overrides
81
+ #
82
82
  # Get multiple jurisdiction override objects across all companies.
83
83
  #
84
84
  # A Jurisdiction Override is a configuration setting that allows you to select the taxing
@@ -91,29 +91,29 @@ module AvaTax
91
91
  #
92
92
  # ### Security Policies
93
93
  #
94
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
94
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
95
95
  # @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:* country, Jurisdictions
96
96
  # @param include [String] A comma separated list of additional data to retrieve.
97
97
  # @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.
98
98
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
99
99
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
100
- # @return [FetchResult]
101
- def query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
102
- get(path, options) end
103
-
104
- # Update a single jurisdictionoverride
105
- #
100
+ # @return [FetchResult]
101
+ def query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
102
+ get(path, options) end
103
+
104
+ # Update a single jurisdictionoverride
105
+ #
106
106
  # Replace the existing jurisdictionoverride object at this URL with an updated object.
107
107
  #
108
108
  # ### Security Policies
109
109
  #
110
- # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
110
+ # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
111
111
  # @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
112
112
  # @param id [Integer] The ID of the jurisdictionoverride you wish to update
113
113
  # @param model [Object] The jurisdictionoverride object you wish to update.
114
- # @return [Object]
115
- def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
116
- put(path, model) end
117
- end
118
- end
114
+ # @return [Object]
115
+ def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
116
+ put(path, model) end
117
+ end
118
+ end
119
119
  end
@@ -1,36 +1,80 @@
1
- module AvaTax
2
- class Client
3
- module Locations
4
-
5
-
6
- # Create a new location
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Locations
4
+
5
+
6
+ # Add parameters to a location.
7
+ #
8
+ # Add parameters to a location.
9
+ #
10
+ # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
11
+ #
12
+ # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
13
+ #
14
+ # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
15
+ #
16
+ # To see available parameters for this location, call `/api/v2/definitions/parameters?$filter=attributeType eq Company`
17
+ #
18
+ # Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter "$showSubscribed=true" to the parameter definition call above.
19
+ #
20
+ # ### Security Policies
21
+ #
22
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
23
+ # @param companyId [Integer] The ID of the company that owns this location parameter.
24
+ # @param locationId [Integer] The location id.
25
+ # @param model [LocationParameterModel[]] The location parameters you wish to create.
26
+ # @return [LocationParameterModel[]]
27
+ def create_location_parameters(companyId, locationId, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
28
+ post(path, model) end
29
+
30
+ # Create a new location
31
+ #
8
32
  # Create one or more new location objects attached to this company.
9
33
  #
10
34
  # ### Security Policies
11
35
  #
12
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
36
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
13
37
  # @param companyId [Integer] The ID of the company that owns this location.
14
38
  # @param model [LocationModel[]] The location you wish to create.
15
- # @return [LocationModel[]]
16
- def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
17
- post(path, model) end
18
-
19
- # Delete a single location
20
- #
39
+ # @return [LocationModel[]]
40
+ def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
41
+ post(path, model) end
42
+
43
+ # Delete a single location
44
+ #
21
45
  # Mark the location object at this URL as deleted.
22
46
  #
23
47
  # ### Security Policies
24
48
  #
25
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
49
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
26
50
  # @param companyId [Integer] The ID of the company that owns this location.
27
51
  # @param id [Integer] The ID of the location you wish to delete.
28
- # @return [ErrorDetail[]]
29
- def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
30
- delete(path) end
31
-
32
- # Retrieve a single location
33
- #
52
+ # @return [ErrorDetail[]]
53
+ def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
54
+ delete(path) end
55
+
56
+ # Delete a single location parameter
57
+ #
58
+ # Delete a single location parameter.
59
+ #
60
+ # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
61
+ #
62
+ # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
63
+ #
64
+ # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
65
+ #
66
+ # ### Security Policies
67
+ #
68
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
69
+ # @param companyId [Integer] The company id
70
+ # @param locationId [Integer] The location id
71
+ # @param id [Integer] The parameter id
72
+ # @return [ErrorDetail[]]
73
+ def delete_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
74
+ delete(path) end
75
+
76
+ # Retrieve a single location
77
+ #
34
78
  # Get the location object identified by this URL.
35
79
  # An 'Location' represents a physical address where a company does business.
36
80
  # Many taxing authorities require that you define a list of all locations where your company does business.
@@ -44,16 +88,62 @@ module AvaTax
44
88
  #
45
89
  # ### Security Policies
46
90
  #
47
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
91
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
48
92
  # @param companyId [Integer] The ID of the company that owns this location
49
93
  # @param id [Integer] The primary key of this location
50
94
  # @param include [String] A comma separated list of additional data to retrieve.
51
- # @return [Object]
52
- def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
53
- get(path, options) end
54
-
55
- # Retrieve locations for this company
56
- #
95
+ # @return [Object]
96
+ def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
97
+ get(path, options) end
98
+
99
+ # Retrieve a single company location parameter
100
+ #
101
+ # Retrieve a single location parameter.
102
+ #
103
+ # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
104
+ #
105
+ # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
106
+ #
107
+ # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
108
+ #
109
+ # ### Security Policies
110
+ #
111
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
112
+ # @param companyId [Integer] The company id
113
+ # @param locationId [Integer] The location id
114
+ # @param id [Integer] The parameter id
115
+ # @return [Object]
116
+ def get_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
117
+ get(path) end
118
+
119
+ # Retrieve parameters for a location
120
+ #
121
+ # List parameters for a location.
122
+ #
123
+ # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
124
+ #
125
+ # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
126
+ #
127
+ # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
128
+ #
129
+ # 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/) .
130
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
131
+ #
132
+ # ### Security Policies
133
+ #
134
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
135
+ # @param companyId [Integer] The company id
136
+ # @param locationId [Integer] The ID of the location
137
+ # @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:* name, unit
138
+ # @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.
139
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
140
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
141
+ # @return [FetchResult]
142
+ def list_location_parameters(companyId, locationId, options={}) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
143
+ get(path, options) end
144
+
145
+ # Retrieve locations for this company
146
+ #
57
147
  # List all location objects defined for this company.
58
148
  # An 'Location' represents a physical address where a company does business.
59
149
  # Many taxing authorities require that you define a list of all locations where your company does business.
@@ -69,19 +159,19 @@ module AvaTax
69
159
  #
70
160
  # ### Security Policies
71
161
  #
72
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
162
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
73
163
  # @param companyId [Integer] The ID of the company that owns these locations
74
- # @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:* settings, parameters
164
+ # @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:* isMarketplaceOutsideUsa, settings, parameters
75
165
  # @param include [String] A comma separated list of additional data to retrieve.
76
166
  # @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.
77
167
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
78
168
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
79
- # @return [FetchResult]
80
- def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
81
- get(path, options) end
82
-
83
- # Retrieve all locations
84
- #
169
+ # @return [FetchResult]
170
+ def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
171
+ get(path, options) end
172
+
173
+ # Retrieve all locations
174
+ #
85
175
  # Get multiple location objects across all companies.
86
176
  # An 'Location' represents a physical address where a company does business.
87
177
  # Many taxing authorities require that you define a list of all locations where your company does business.
@@ -98,46 +188,67 @@ module AvaTax
98
188
  #
99
189
  # ### Security Policies
100
190
  #
101
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
102
- # @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:* settings, parameters
191
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
192
+ # @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:* isMarketplaceOutsideUsa, settings, parameters
103
193
  # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
104
194
  # @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.
105
195
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
106
196
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
107
- # @return [FetchResult]
108
- def query_locations(options={}) path = "/api/v2/locations"
109
- get(path, options) end
110
-
111
- # Update a single location
112
- #
197
+ # @return [FetchResult]
198
+ def query_locations(options={}) path = "/api/v2/locations"
199
+ get(path, options) end
200
+
201
+ # Update a single location
202
+ #
113
203
  # Replace the existing location object at this URL with an updated object.
114
204
  # All data from the existing object will be replaced with data in the object you PUT.
115
205
  # 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.
116
206
  #
117
207
  # ### Security Policies
118
208
  #
119
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
209
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
120
210
  # @param companyId [Integer] The ID of the company that this location belongs to.
121
211
  # @param id [Integer] The ID of the location you wish to update
122
212
  # @param model [Object] The location you wish to update.
123
- # @return [Object]
124
- def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
125
- put(path, model) end
126
-
127
- # Validate the location against local requirements
128
- #
213
+ # @return [Object]
214
+ def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
215
+ put(path, model) end
216
+
217
+ # Update a location parameter
218
+ #
219
+ # Update a location parameter.
220
+ #
221
+ # Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters".
222
+ #
223
+ # A parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
224
+ #
225
+ # A parameter specified on a transaction line will override a location parameter if they share the same parameter name.
226
+ #
227
+ # ### Security Policies
228
+ #
229
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
230
+ # @param companyId [Integer] The company id.
231
+ # @param locationId [Integer] The location id
232
+ # @param id [Integer] The location parameter id
233
+ # @param model [Object] The location parameter object you wish to update.
234
+ # @return [Object]
235
+ def update_location_parameter(companyId, locationId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
236
+ put(path, model) end
237
+
238
+ # Validate the location against local requirements
239
+ #
129
240
  # Returns validation information for this location.
130
241
  # This API call is intended to compare this location against the currently known taxing authority rules and regulations,
131
242
  # and provide information about what additional work is required to completely setup this location.
132
243
  #
133
244
  # ### Security Policies
134
245
  #
135
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
246
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
136
247
  # @param companyId [Integer] The ID of the company that owns this location
137
248
  # @param id [Integer] The primary key of this location
138
- # @return [Object]
139
- def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
140
- get(path) end
141
- end
142
- end
249
+ # @return [Object]
250
+ def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
251
+ get(path) end
252
+ end
253
+ end
143
254
  end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module MultiDocument
4
-
5
-
6
- # Adjust a MultiDocument transaction
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module MultiDocument
4
+
5
+
6
+ # Adjust a MultiDocument transaction
7
+ #
8
8
  # Adjusts the current MultiDocument transaction uniquely identified by this URL.
9
9
  #
10
10
  # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -20,22 +20,24 @@ module AvaTax
20
20
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
21
21
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
22
22
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
23
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
24
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
23
25
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
24
26
  #
25
27
  # ### Security Policies
26
28
  #
27
29
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
28
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
30
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
29
31
  # @param code [String] The transaction code for this MultiDocument transaction
30
32
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
31
33
  # @param include [String] Specifies objects to include in this fetch call
32
34
  # @param model [Object] The adjust request you wish to execute
33
- # @return [Object]
34
- def adjust_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
35
- post(path, model, options) end
36
-
37
- # Get audit information about a MultiDocument transaction
38
- #
35
+ # @return [Object]
36
+ def adjust_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
37
+ post(path, model, options) end
38
+
39
+ # Get audit information about a MultiDocument transaction
40
+ #
39
41
  # Retrieve audit information about a MultiDocument transaction stored in AvaTax.
40
42
  #
41
43
  # The audit API retrieves audit information related to a specific MultiDocument transaction. This audit
@@ -55,20 +57,22 @@ module AvaTax
55
57
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
56
58
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
57
59
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
60
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
61
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
58
62
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
59
63
  #
60
64
  # ### Security Policies
61
65
  #
62
66
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
63
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
67
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
64
68
  # @param code [String] The transaction code for this MultiDocument transaction
65
69
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
66
- # @return [Object]
67
- def audit_multi_document_transaction(code, type) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
68
- get(path) end
69
-
70
- # Commit a MultiDocument transaction
71
- #
70
+ # @return [Object]
71
+ def audit_multi_document_transaction(code, type) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
72
+ get(path) end
73
+
74
+ # Commit a MultiDocument transaction
75
+ #
72
76
  # Marks a list of transactions by changing its status to `Committed`.
73
77
  #
74
78
  # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
@@ -82,19 +86,21 @@ module AvaTax
82
86
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
83
87
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
84
88
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
89
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
90
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
85
91
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
86
92
  #
87
93
  # ### Security Policies
88
94
  #
89
95
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
90
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
96
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
91
97
  # @param model [Object] The commit request you wish to execute
92
- # @return [Object]
93
- def commit_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/commit"
94
- post(path, model) end
95
-
96
- # Create a new MultiDocument transaction
97
- #
98
+ # @return [Object]
99
+ def commit_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/commit"
100
+ post(path, model) end
101
+
102
+ # Create a new MultiDocument transaction
103
+ #
98
104
  # Records a new MultiDocument transaction in AvaTax.
99
105
  #
100
106
  # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -132,20 +138,22 @@ module AvaTax
132
138
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
133
139
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
134
140
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
141
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
142
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
135
143
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
136
144
  #
137
145
  # ### Security Policies
138
146
  #
139
147
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
140
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
148
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
141
149
  # @param include [String] Specifies objects to include in the response after transaction is created
142
150
  # @param model [Object] the multi document transaction model
143
- # @return [Object]
144
- def create_multi_document_transaction(model, options={}) path = "/api/v2/transactions/multidocument"
145
- post(path, model, options) end
146
-
147
- # Retrieve a MultiDocument transaction
148
- #
151
+ # @return [Object]
152
+ def create_multi_document_transaction(model, options={}) path = "/api/v2/transactions/multidocument"
153
+ post(path, model, options) end
154
+
155
+ # Retrieve a MultiDocument transaction
156
+ #
149
157
  # Get the current MultiDocument transaction identified by this URL.
150
158
  #
151
159
  # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
@@ -163,21 +171,23 @@ module AvaTax
163
171
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
164
172
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
165
173
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
174
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
175
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
166
176
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
167
177
  #
168
178
  # ### Security Policies
169
179
  #
170
180
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
171
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
172
- # @param code [String]
173
- # @param type [String] (See DocumentType::* for a list of allowable values)
181
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
182
+ # @param code [String] The multidocument code to retrieve
183
+ # @param type [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
174
184
  # @param include [String] Specifies objects to include in the response after transaction is created
175
- # @return [Object]
176
- def get_multi_document_transaction_by_code_and_type(code, type, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
177
- get(path, options) end
178
-
179
- # Retrieve a MultiDocument transaction by ID
180
- #
185
+ # @return [Object]
186
+ def get_multi_document_transaction_by_code_and_type(code, type, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
187
+ get(path, options) end
188
+
189
+ # Retrieve a MultiDocument transaction by ID
190
+ #
181
191
  # Get the unique MultiDocument transaction identified by this URL.
182
192
  #
183
193
  # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -204,20 +214,22 @@ module AvaTax
204
214
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
205
215
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
206
216
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
217
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
218
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
207
219
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
208
220
  #
209
221
  # ### Security Policies
210
222
  #
211
223
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
212
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
224
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
213
225
  # @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
214
226
  # @param include [String] Specifies objects to include in the response after transaction is created
215
- # @return [Object]
216
- def get_multi_document_transaction_by_id(id, options={}) path = "/api/v2/transactions/multidocument/#{id}"
217
- get(path, options) end
218
-
219
- # Retrieve all MultiDocument transactions
220
- #
227
+ # @return [Object]
228
+ def get_multi_document_transaction_by_id(id, options={}) path = "/api/v2/transactions/multidocument/#{id}"
229
+ get(path, options) end
230
+
231
+ # Retrieve all MultiDocument transactions
232
+ #
221
233
  # List all MultiDocument transactions within this account.
222
234
  #
223
235
  # This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument
@@ -242,23 +254,25 @@ module AvaTax
242
254
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
243
255
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
244
256
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
257
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
258
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
245
259
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
246
260
  #
247
261
  # ### Security Policies
248
262
  #
249
263
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
250
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
264
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
251
265
  # @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:* documents
252
266
  # @param include [String] Specifies objects to include in the response after transaction is created
253
267
  # @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.
254
268
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
255
269
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
256
- # @return [FetchResult]
257
- def list_multi_document_transactions(options={}) path = "/api/v2/transactions/multidocument"
258
- get(path, options) end
259
-
260
- # Create a refund for a MultiDocument transaction
261
- #
270
+ # @return [FetchResult]
271
+ def list_multi_document_transactions(options={}) path = "/api/v2/transactions/multidocument"
272
+ get(path, options) end
273
+
274
+ # Create a refund for a MultiDocument transaction
275
+ #
262
276
  # Create a refund for a MultiDocument transaction.
263
277
  #
264
278
  # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -300,22 +314,24 @@ module AvaTax
300
314
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
301
315
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
302
316
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
317
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
318
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
303
319
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
304
320
  #
305
321
  # ### Security Policies
306
322
  #
307
323
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
308
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
324
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
309
325
  # @param code [String] The code of this MultiDocument transaction
310
326
  # @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
311
327
  # @param include [String] Specifies objects to include in the response after transaction is created
312
328
  # @param model [Object] Information about the refund to create
313
- # @return [Object]
314
- def refund_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
315
- post(path, model, options) end
316
-
317
- # Verify a MultiDocument transaction
318
- #
329
+ # @return [Object]
330
+ def refund_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
331
+ post(path, model, options) end
332
+
333
+ # Verify a MultiDocument transaction
334
+ #
319
335
  # Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
320
336
  #
321
337
  # If the transaction does not match these expected values, this API will return an error code indicating which value did not match.
@@ -327,19 +343,21 @@ module AvaTax
327
343
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
328
344
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
329
345
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
346
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
347
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
330
348
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
331
349
  #
332
350
  # ### Security Policies
333
351
  #
334
352
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
335
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
353
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
336
354
  # @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
337
- # @return [Object]
338
- def verify_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/verify"
339
- post(path, model) end
340
-
341
- # Void a MultiDocument transaction
342
- #
355
+ # @return [Object]
356
+ def verify_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/verify"
357
+ post(path, model) end
358
+
359
+ # Void a MultiDocument transaction
360
+ #
343
361
  # Voids the current transaction uniquely identified by this URL.
344
362
  #
345
363
  # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -354,18 +372,20 @@ module AvaTax
354
372
  # * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code
355
373
  # * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code
356
374
  # * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code
375
+ # * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code
376
+ # * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code
357
377
  # * Replace ' ' with '%20' For example: document Code becomes document%20Code
358
378
  #
359
379
  # ### Security Policies
360
380
  #
361
381
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
362
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
382
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro.
363
383
  # @param code [String] The transaction code for this MultiDocument transaction
364
384
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
365
385
  # @param model [Object] The void request you wish to execute
366
- # @return [Object]
367
- def void_multi_document_transaction(code, type, model) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
368
- post(path, model) end
369
- end
370
- end
386
+ # @return [Object]
387
+ def void_multi_document_transaction(code, type, model) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
388
+ post(path, model) end
389
+ end
390
+ end
371
391
  end