avatax 22.8.0 → 22.10.0
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.
- checksums.yaml +4 -4
- data/avatax.gemspec +2 -2
- data/lib/avatax/client/accounts.rb +11 -11
- data/lib/avatax/client/addresses.rb +2 -2
- data/lib/avatax/client/advancedrules.rb +5 -5
- data/lib/avatax/client/avafileforms.rb +5 -5
- data/lib/avatax/client/batches.rb +8 -8
- data/lib/avatax/client/certexpressinvites.rb +3 -3
- data/lib/avatax/client/certificates.rb +15 -15
- data/lib/avatax/client/companies.rb +22 -22
- data/lib/avatax/client/compliance.rb +1 -1
- data/lib/avatax/client/contacts.rb +6 -6
- data/lib/avatax/client/customers.rb +13 -13
- data/lib/avatax/client/datasources.rb +6 -6
- data/lib/avatax/client/definitions.rb +71 -71
- data/lib/avatax/client/distancethresholds.rb +6 -6
- data/lib/avatax/client/ecommercetoken.rb +2 -2
- data/lib/avatax/client/firmclientlinkages.rb +9 -9
- data/lib/avatax/client/free.rb +1 -1
- data/lib/avatax/client/fundingrequests.rb +2 -2
- data/lib/avatax/client/items.rb +32 -32
- data/lib/avatax/client/jurisdictionoverrides.rb +6 -6
- data/lib/avatax/client/locations.rb +12 -12
- data/lib/avatax/client/multidocument.rb +10 -10
- data/lib/avatax/client/nexus.rb +15 -15
- data/lib/avatax/client/notices.rb +4 -4
- data/lib/avatax/client/notifications.rb +3 -3
- data/lib/avatax/client/provisioning.rb +2 -2
- data/lib/avatax/client/registrar.rb +88 -10
- data/lib/avatax/client/reports.rb +4 -4
- data/lib/avatax/client/settings.rb +6 -6
- data/lib/avatax/client/subscriptions.rb +3 -3
- data/lib/avatax/client/taxcodes.rb +6 -6
- data/lib/avatax/client/taxcontent.rb +5 -5
- data/lib/avatax/client/taxrules.rb +6 -6
- data/lib/avatax/client/transactions.rb +21 -21
- data/lib/avatax/client/upcs.rb +6 -6
- data/lib/avatax/client/userdefinedfields.rb +3 -3
- data/lib/avatax/client/users.rb +8 -8
- data/lib/avatax/client/utilities.rb +3 -3
- data/lib/avatax/client.rb +1 -0
- data/lib/avatax/version.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1000b2df35c362a561fc4d331d4b90fe03c5817abd5508cd52140444f0935f4a
|
4
|
+
data.tar.gz: 6b52919969113f2edfe4cc96845caaf9a2e8af6b3e2e4a75de1491c7f95a5a5f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 306d56280b7d0981db9005a2839377b43ff5618c57cb97b890443deaa7bf26d2efb1dc8313e7e41c27f965ac9fdc10767a5d8c95591bf296ad61fc4724563a58
|
7
|
+
data.tar.gz: 2030b4bd3dd9fd75378856cb8df0808638581560d2d7c75d77dc639962504ea2d1751c721e1c62c139139b63c45597e510b6b4255586b5210a9c5acfc16b183d
|
data/avatax.gemspec
CHANGED
@@ -15,12 +15,12 @@ Gem::Specification.new do |s|
|
|
15
15
|
AvaTax REST API
|
16
16
|
------------------------------
|
17
17
|
Our developer site documents the AvaTax REST API.
|
18
|
-
(
|
18
|
+
(https://developer.avalara.com).
|
19
19
|
Blog
|
20
20
|
----------------------------
|
21
21
|
The Developer Blog is a great place to learn more about the API and AvaTax integrations
|
22
22
|
Subscribe to the RSS feed be notified of new posts:
|
23
|
-
(
|
23
|
+
(https://developer.avalara.com/blogs).
|
24
24
|
|
25
25
|
********************************************************************************
|
26
26
|
eos
|
@@ -28,7 +28,7 @@ module AvaTax
|
|
28
28
|
# @param model [Object] A request confirming that you wish to reset the license key of this account.
|
29
29
|
# @return [Object]
|
30
30
|
def account_reset_license_key(id, model) path = "/api/v2/accounts/#{id}/resetlicensekey"
|
31
|
-
post(path, model, {}, "22.
|
31
|
+
post(path, model, {}, "22.10.0") end
|
32
32
|
|
33
33
|
# Activate an account by accepting terms and conditions
|
34
34
|
#
|
@@ -51,7 +51,7 @@ module AvaTax
|
|
51
51
|
# @param model [Object] The activation request
|
52
52
|
# @return [Object]
|
53
53
|
def activate_account(id, model) path = "/api/v2/accounts/#{id}/activate"
|
54
|
-
post(path, model, {}, "22.
|
54
|
+
post(path, model, {}, "22.10.0") end
|
55
55
|
|
56
56
|
# Retrieve audit history for an account.
|
57
57
|
#
|
@@ -81,7 +81,7 @@ module AvaTax
|
|
81
81
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
82
82
|
# @return [FetchResult]
|
83
83
|
def audit_account(id, options={}) path = "/api/v2/accounts/#{id}/audit"
|
84
|
-
get(path, options, "22.
|
84
|
+
get(path, options, "22.10.0") end
|
85
85
|
|
86
86
|
# Create license key for this account
|
87
87
|
#
|
@@ -104,7 +104,7 @@ module AvaTax
|
|
104
104
|
# @param model [Object]
|
105
105
|
# @return [Object]
|
106
106
|
def create_license_key(id, model) path = "/api/v2/accounts/#{id}/licensekey"
|
107
|
-
post(path, model, {}, "22.
|
107
|
+
post(path, model, {}, "22.10.0") end
|
108
108
|
|
109
109
|
# Delete license key for this account by license key name
|
110
110
|
#
|
@@ -122,7 +122,7 @@ module AvaTax
|
|
122
122
|
# @param licensekeyname [String] The license key name you wish to update.
|
123
123
|
# @return [ErrorDetail[]]
|
124
124
|
def delete_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
|
125
|
-
delete(path, {}, "22.
|
125
|
+
delete(path, {}, "22.10.0") end
|
126
126
|
|
127
127
|
# Retrieve a single account
|
128
128
|
#
|
@@ -140,7 +140,7 @@ module AvaTax
|
|
140
140
|
# @param include [String] A comma separated list of special fetch options
|
141
141
|
# @return [Object]
|
142
142
|
def get_account(id, options={}) path = "/api/v2/accounts/#{id}"
|
143
|
-
get(path, options, "22.
|
143
|
+
get(path, options, "22.10.0") end
|
144
144
|
|
145
145
|
# Get configuration settings for this account
|
146
146
|
#
|
@@ -164,7 +164,7 @@ module AvaTax
|
|
164
164
|
# @param id [Integer]
|
165
165
|
# @return [AccountConfigurationModel[]]
|
166
166
|
def get_account_configuration(id) path = "/api/v2/accounts/#{id}/configuration"
|
167
|
-
get(path, {}, "22.
|
167
|
+
get(path, {}, "22.10.0") end
|
168
168
|
|
169
169
|
# Retrieve license key by license key name
|
170
170
|
#
|
@@ -176,7 +176,7 @@ module AvaTax
|
|
176
176
|
# @param licensekeyname [String] The ID of the account to retrieve
|
177
177
|
# @return [Object]
|
178
178
|
def get_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
|
179
|
-
get(path, {}, "22.
|
179
|
+
get(path, {}, "22.10.0") end
|
180
180
|
|
181
181
|
# Retrieve all license keys for this account
|
182
182
|
#
|
@@ -189,7 +189,7 @@ module AvaTax
|
|
189
189
|
# @param id [Integer] The ID of the account to retrieve
|
190
190
|
# @return [AccountLicenseKeyModel[]]
|
191
191
|
def get_license_keys(id) path = "/api/v2/accounts/#{id}/licensekeys"
|
192
|
-
get(path, {}, "22.
|
192
|
+
get(path, {}, "22.10.0") end
|
193
193
|
|
194
194
|
# Retrieve all accounts
|
195
195
|
#
|
@@ -217,7 +217,7 @@ module AvaTax
|
|
217
217
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
218
218
|
# @return [FetchResult]
|
219
219
|
def query_accounts(options={}) path = "/api/v2/accounts"
|
220
|
-
get(path, options, "22.
|
220
|
+
get(path, options, "22.10.0") end
|
221
221
|
|
222
222
|
# Change configuration settings for this account
|
223
223
|
#
|
@@ -242,7 +242,7 @@ module AvaTax
|
|
242
242
|
# @param model [AccountConfigurationModel[]]
|
243
243
|
# @return [AccountConfigurationModel[]]
|
244
244
|
def set_account_configuration(id, model) path = "/api/v2/accounts/#{id}/configuration"
|
245
|
-
post(path, model, {}, "22.
|
245
|
+
post(path, model, {}, "22.10.0") end
|
246
246
|
end
|
247
247
|
end
|
248
248
|
end
|
@@ -32,7 +32,7 @@ module AvaTax
|
|
32
32
|
# @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
|
33
33
|
# @return [Object]
|
34
34
|
def resolve_address(options={}) path = "/api/v2/addresses/resolve"
|
35
|
-
get(path, options, "22.
|
35
|
+
get(path, options, "22.10.0") end
|
36
36
|
|
37
37
|
# Retrieve geolocation information for a specified address
|
38
38
|
#
|
@@ -51,7 +51,7 @@ module AvaTax
|
|
51
51
|
# @param model [Object] The address to resolve
|
52
52
|
# @return [Object]
|
53
53
|
def resolve_address_post(model) path = "/api/v2/addresses/resolve"
|
54
|
-
post(path, model, {}, "22.
|
54
|
+
post(path, model, {}, "22.10.0") end
|
55
55
|
end
|
56
56
|
end
|
57
57
|
end
|
@@ -12,7 +12,7 @@ module AvaTax
|
|
12
12
|
# @param model [Object] The lookup file you wish to create
|
13
13
|
# @return [Object]
|
14
14
|
def create_company_lookup_file(accountId, companyId, model) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
|
15
|
-
post(path, model, {}, "22.
|
15
|
+
post(path, model, {}, "22.10.0") end
|
16
16
|
|
17
17
|
# Delete a lookup file
|
18
18
|
#
|
@@ -22,7 +22,7 @@ module AvaTax
|
|
22
22
|
# @param id [String] The unique ID/GUID for the company lookup file to be deleted
|
23
23
|
# @return [ErrorDetail[]]
|
24
24
|
def delete_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
|
25
|
-
delete(path, {}, "22.
|
25
|
+
delete(path, {}, "22.10.0") end
|
26
26
|
|
27
27
|
# Get the lookup files for a company
|
28
28
|
#
|
@@ -32,7 +32,7 @@ module AvaTax
|
|
32
32
|
# @param companyId [Integer] The ID of the company for which to retrieve lookup files
|
33
33
|
# @return [FetchResult]
|
34
34
|
def get_company_lookup_files(accountId, companyId) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
|
35
|
-
get(path, {}, "22.
|
35
|
+
get(path, {}, "22.10.0") end
|
36
36
|
|
37
37
|
# Get a lookup file for an accountId and companyLookupFileId
|
38
38
|
#
|
@@ -42,7 +42,7 @@ module AvaTax
|
|
42
42
|
# @param id [String] The unique ID/GUID of the company lookup file to return
|
43
43
|
# @return [Object]
|
44
44
|
def get_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
|
45
|
-
get(path, {}, "22.
|
45
|
+
get(path, {}, "22.10.0") end
|
46
46
|
|
47
47
|
# Update a lookup file
|
48
48
|
#
|
@@ -53,7 +53,7 @@ module AvaTax
|
|
53
53
|
# @param model [Object] The new values to update the lookup file
|
54
54
|
# @return [Object]
|
55
55
|
def update_lookup_file(accountId, id, model) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
|
56
|
-
put(path, model, {}, "22.
|
56
|
+
put(path, model, {}, "22.10.0") end
|
57
57
|
end
|
58
58
|
end
|
59
59
|
end
|
@@ -16,7 +16,7 @@ module AvaTax
|
|
16
16
|
# @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
|
17
17
|
# @return [AvaFileFormModel[]]
|
18
18
|
def create_ava_file_forms(model) path = "/api/v2/avafileforms"
|
19
|
-
post(path, model, {}, "22.
|
19
|
+
post(path, model, {}, "22.10.0") end
|
20
20
|
|
21
21
|
# Delete a single AvaFileForm
|
22
22
|
#
|
@@ -30,7 +30,7 @@ module AvaTax
|
|
30
30
|
# @param id [Integer] The ID of the AvaFileForm you wish to delete.
|
31
31
|
# @return [ErrorDetail[]]
|
32
32
|
def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
33
|
-
delete(path, {}, "22.
|
33
|
+
delete(path, {}, "22.10.0") end
|
34
34
|
|
35
35
|
# Retrieve a single AvaFileForm
|
36
36
|
#
|
@@ -44,7 +44,7 @@ module AvaTax
|
|
44
44
|
# @param id [Integer] The primary key of this AvaFileForm
|
45
45
|
# @return [Object]
|
46
46
|
def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
|
47
|
-
get(path, {}, "22.
|
47
|
+
get(path, {}, "22.10.0") end
|
48
48
|
|
49
49
|
# Retrieve all AvaFileForms
|
50
50
|
#
|
@@ -62,7 +62,7 @@ module AvaTax
|
|
62
62
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
63
63
|
# @return [FetchResult]
|
64
64
|
def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
|
65
|
-
get(path, options, "22.
|
65
|
+
get(path, options, "22.10.0") end
|
66
66
|
|
67
67
|
# Update a AvaFileForm
|
68
68
|
#
|
@@ -78,7 +78,7 @@ module AvaTax
|
|
78
78
|
# @param model [Object] The AvaFileForm model you wish to update.
|
79
79
|
# @return [Object]
|
80
80
|
def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
|
81
|
-
put(path, model, {}, "22.
|
81
|
+
put(path, model, {}, "22.10.0") end
|
82
82
|
end
|
83
83
|
end
|
84
84
|
end
|
@@ -26,7 +26,7 @@ module AvaTax
|
|
26
26
|
# @param id [Integer] The ID of the batch to cancel.
|
27
27
|
# @return [Object]
|
28
28
|
def cancel_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
|
29
|
-
post(path, {}, "22.
|
29
|
+
post(path, {}, "22.10.0") end
|
30
30
|
|
31
31
|
# Create a new batch
|
32
32
|
#
|
@@ -58,7 +58,7 @@ module AvaTax
|
|
58
58
|
# @param model [BatchModel[]] The batch you wish to create.
|
59
59
|
# @return [BatchModel[]]
|
60
60
|
def create_batches(companyId, model) path = "/api/v2/companies/#{companyId}/batches"
|
61
|
-
post(path, model, {}, "22.
|
61
|
+
post(path, model, {}, "22.10.0") end
|
62
62
|
|
63
63
|
# Create a new transaction batch
|
64
64
|
#
|
@@ -88,7 +88,7 @@ module AvaTax
|
|
88
88
|
# @param model [Object] The transaction batch you wish to create.
|
89
89
|
# @return [Object]
|
90
90
|
def create_transaction_batch(companyId, model) path = "/api/v2/companies/#{companyId}/batches/transactions"
|
91
|
-
post(path, model, {}, "22.
|
91
|
+
post(path, model, {}, "22.10.0") end
|
92
92
|
|
93
93
|
# Delete a single batch
|
94
94
|
#
|
@@ -111,7 +111,7 @@ module AvaTax
|
|
111
111
|
# @param id [Integer] The ID of the batch to delete.
|
112
112
|
# @return [ErrorDetail[]]
|
113
113
|
def delete_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
114
|
-
delete(path, {}, "22.
|
114
|
+
delete(path, {}, "22.10.0") end
|
115
115
|
|
116
116
|
# Download a single batch file
|
117
117
|
#
|
@@ -126,7 +126,7 @@ module AvaTax
|
|
126
126
|
# @param id [Integer] The primary key of this batch file object
|
127
127
|
# @return [Object]
|
128
128
|
def download_batch(companyId, batchId, id) path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
|
129
|
-
get(path, {}, "22.
|
129
|
+
get(path, {}, "22.10.0") end
|
130
130
|
|
131
131
|
# Retrieve a single batch
|
132
132
|
#
|
@@ -154,7 +154,7 @@ module AvaTax
|
|
154
154
|
# @param id [Integer] The primary key of this batch
|
155
155
|
# @return [Object]
|
156
156
|
def get_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
|
157
|
-
get(path, {}, "22.
|
157
|
+
get(path, {}, "22.10.0") end
|
158
158
|
|
159
159
|
# Retrieve all batches for this company
|
160
160
|
#
|
@@ -192,7 +192,7 @@ module AvaTax
|
|
192
192
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
193
193
|
# @return [FetchResult]
|
194
194
|
def list_batches_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/batches"
|
195
|
-
get(path, options, "22.
|
195
|
+
get(path, options, "22.10.0") end
|
196
196
|
|
197
197
|
# Retrieve all batches
|
198
198
|
#
|
@@ -226,7 +226,7 @@ module AvaTax
|
|
226
226
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
227
227
|
# @return [FetchResult]
|
228
228
|
def query_batches(options={}) path = "/api/v2/batches"
|
229
|
-
get(path, options, "22.
|
229
|
+
get(path, options, "22.10.0") end
|
230
230
|
end
|
231
231
|
end
|
232
232
|
end
|
@@ -31,7 +31,7 @@ module AvaTax
|
|
31
31
|
# @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
|
32
32
|
# @return [CertExpressInvitationStatusModel[]]
|
33
33
|
def create_cert_express_invitation(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
|
34
|
-
post(path, model, {}, "22.
|
34
|
+
post(path, model, {}, "22.10.0") end
|
35
35
|
|
36
36
|
# Retrieve a single CertExpress invitation
|
37
37
|
#
|
@@ -62,7 +62,7 @@ module AvaTax
|
|
62
62
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
|
63
63
|
# @return [Object]
|
64
64
|
def get_cert_express_invitation(companyId, customerCode, id, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
|
65
|
-
get(path, options, "22.
|
65
|
+
get(path, options, "22.10.0") end
|
66
66
|
|
67
67
|
# List CertExpress invitations
|
68
68
|
#
|
@@ -95,7 +95,7 @@ module AvaTax
|
|
95
95
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
96
96
|
# @return [FetchResult]
|
97
97
|
def list_cert_express_invitations(companyId, options={}) path = "/api/v2/companies/#{companyId}/certexpressinvites"
|
98
|
-
get(path, options, "22.
|
98
|
+
get(path, options, "22.10.0") end
|
99
99
|
end
|
100
100
|
end
|
101
101
|
end
|
@@ -37,7 +37,7 @@ module AvaTax
|
|
37
37
|
# @param model [CertificateModel[]] Certificates to be created
|
38
38
|
# @return [CertificateModel[]]
|
39
39
|
def create_certificates(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/certificates"
|
40
|
-
post(path, model, options, "22.
|
40
|
+
post(path, model, options, "22.10.0") end
|
41
41
|
|
42
42
|
# Revoke and delete a certificate
|
43
43
|
#
|
@@ -64,7 +64,7 @@ module AvaTax
|
|
64
64
|
# @param id [Integer] The unique ID number of this certificate
|
65
65
|
# @return [ErrorDetail[]]
|
66
66
|
def delete_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
67
|
-
delete(path, {}, "22.
|
67
|
+
delete(path, {}, "22.10.0") end
|
68
68
|
|
69
69
|
# Download an image for this certificate
|
70
70
|
#
|
@@ -94,7 +94,7 @@ module AvaTax
|
|
94
94
|
# @param type [String] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)
|
95
95
|
# @return [Object]
|
96
96
|
def download_certificate_image(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
|
97
|
-
get(path, options, "22.
|
97
|
+
get(path, options, "22.10.0") end
|
98
98
|
|
99
99
|
# Retrieve a single certificate
|
100
100
|
#
|
@@ -126,7 +126,7 @@ module AvaTax
|
|
126
126
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
|
127
127
|
# @return [Object]
|
128
128
|
def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
129
|
-
get(path, options, "22.
|
129
|
+
get(path, options, "22.10.0") end
|
130
130
|
|
131
131
|
# Check a company's exemption certificate status.
|
132
132
|
#
|
@@ -146,7 +146,7 @@ module AvaTax
|
|
146
146
|
# @param companyId [Integer] The company ID to check
|
147
147
|
# @return [Object]
|
148
148
|
def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
|
149
|
-
get(path, {}, "22.
|
149
|
+
get(path, {}, "22.10.0") end
|
150
150
|
|
151
151
|
# Link attributes to a certificate
|
152
152
|
#
|
@@ -175,7 +175,7 @@ module AvaTax
|
|
175
175
|
# @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
|
176
176
|
# @return [FetchResult]
|
177
177
|
def link_attributes_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
|
178
|
-
post(path, model, {}, "22.
|
178
|
+
post(path, model, {}, "22.10.0") end
|
179
179
|
|
180
180
|
# Link customers to a certificate
|
181
181
|
#
|
@@ -205,7 +205,7 @@ module AvaTax
|
|
205
205
|
# @param model [Object] The list of customers needed be added to the Certificate for exemption
|
206
206
|
# @return [FetchResult]
|
207
207
|
def link_customers_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
|
208
|
-
post(path, model, {}, "22.
|
208
|
+
post(path, model, {}, "22.10.0") end
|
209
209
|
|
210
210
|
# List all attributes applied to this certificate
|
211
211
|
#
|
@@ -233,7 +233,7 @@ module AvaTax
|
|
233
233
|
# @param id [Integer] The unique ID number of this certificate
|
234
234
|
# @return [FetchResult]
|
235
235
|
def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
|
236
|
-
get(path, {}, "22.
|
236
|
+
get(path, {}, "22.10.0") end
|
237
237
|
|
238
238
|
# List customers linked to this certificate
|
239
239
|
#
|
@@ -262,7 +262,7 @@ module AvaTax
|
|
262
262
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
|
263
263
|
# @return [FetchResult]
|
264
264
|
def list_customers_for_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
|
265
|
-
get(path, options, "22.
|
265
|
+
get(path, options, "22.10.0") end
|
266
266
|
|
267
267
|
# List all certificates for a company
|
268
268
|
#
|
@@ -297,7 +297,7 @@ module AvaTax
|
|
297
297
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
298
298
|
# @return [FetchResult]
|
299
299
|
def query_certificates(companyId, options={}) path = "/api/v2/companies/#{companyId}/certificates"
|
300
|
-
get(path, options, "22.
|
300
|
+
get(path, options, "22.10.0") end
|
301
301
|
|
302
302
|
# Request setup of exemption certificates for this company.
|
303
303
|
#
|
@@ -319,7 +319,7 @@ module AvaTax
|
|
319
319
|
# @param companyId [Integer]
|
320
320
|
# @return [Object]
|
321
321
|
def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
|
322
|
-
post(path, {}, "22.
|
322
|
+
post(path, {}, "22.10.0") end
|
323
323
|
|
324
324
|
# Unlink attributes from a certificate
|
325
325
|
#
|
@@ -348,7 +348,7 @@ module AvaTax
|
|
348
348
|
# @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
|
349
349
|
# @return [FetchResult]
|
350
350
|
def unlink_attributes_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
|
351
|
-
post(path, model, {}, "22.
|
351
|
+
post(path, model, {}, "22.10.0") end
|
352
352
|
|
353
353
|
# Unlink customers from a certificate
|
354
354
|
#
|
@@ -379,7 +379,7 @@ module AvaTax
|
|
379
379
|
# @param model [Object] The list of customers to unlink from this certificate
|
380
380
|
# @return [FetchResult]
|
381
381
|
def unlink_customers_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
|
382
|
-
post(path, model, {}, "22.
|
382
|
+
post(path, model, {}, "22.10.0") end
|
383
383
|
|
384
384
|
# Update a single certificate
|
385
385
|
#
|
@@ -405,7 +405,7 @@ module AvaTax
|
|
405
405
|
# @param model [Object] The new certificate object that will replace the existing one
|
406
406
|
# @return [Object]
|
407
407
|
def update_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
|
408
|
-
put(path, model, {}, "22.
|
408
|
+
put(path, model, {}, "22.10.0") end
|
409
409
|
|
410
410
|
# Upload an image or PDF attachment for this certificate
|
411
411
|
#
|
@@ -434,7 +434,7 @@ module AvaTax
|
|
434
434
|
# @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
|
435
435
|
# @return [String]
|
436
436
|
def upload_certificate_image(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
|
437
|
-
post(path, {}, "22.
|
437
|
+
post(path, {}, "22.10.0") end
|
438
438
|
end
|
439
439
|
end
|
440
440
|
end
|
@@ -36,7 +36,7 @@ module AvaTax
|
|
36
36
|
# @param id [Integer] The ID of the company to check if its integration is certified.
|
37
37
|
# @return [String]
|
38
38
|
def certify_integration(id) path = "/api/v2/companies/#{id}/certify"
|
39
|
-
get(path, {}, "22.
|
39
|
+
get(path, {}, "22.10.0") end
|
40
40
|
|
41
41
|
# Change the filing status of this company
|
42
42
|
#
|
@@ -62,7 +62,7 @@ module AvaTax
|
|
62
62
|
# @param model [Object]
|
63
63
|
# @return [String]
|
64
64
|
def change_filing_status(id, model) path = "/api/v2/companies/#{id}/filingstatus"
|
65
|
-
post(path, model, {}, "22.
|
65
|
+
post(path, model, {}, "22.10.0") end
|
66
66
|
|
67
67
|
# Quick setup for a company with a single physical address
|
68
68
|
#
|
@@ -86,7 +86,7 @@ module AvaTax
|
|
86
86
|
# @param model [Object] Information about the company you wish to create.
|
87
87
|
# @return [Object]
|
88
88
|
def company_initialize(model) path = "/api/v2/companies/initialize"
|
89
|
-
post(path, model, {}, "22.
|
89
|
+
post(path, model, {}, "22.10.0") end
|
90
90
|
|
91
91
|
# Create new companies
|
92
92
|
#
|
@@ -103,7 +103,7 @@ module AvaTax
|
|
103
103
|
# @param model [CompanyModel[]] Either a single company object or an array of companies to create
|
104
104
|
# @return [CompanyModel[]]
|
105
105
|
def create_companies(model) path = "/api/v2/companies"
|
106
|
-
post(path, model, {}, "22.
|
106
|
+
post(path, model, {}, "22.10.0") end
|
107
107
|
|
108
108
|
# Add parameters to a company.
|
109
109
|
#
|
@@ -127,7 +127,7 @@ module AvaTax
|
|
127
127
|
# @param model [CompanyParameterDetailModel[]] The company parameters you wish to create.
|
128
128
|
# @return [CompanyParameterDetailModel[]]
|
129
129
|
def create_company_parameters(companyId, model) path = "/api/v2/companies/#{companyId}/parameters"
|
130
|
-
post(path, model, {}, "22.
|
130
|
+
post(path, model, {}, "22.10.0") end
|
131
131
|
|
132
132
|
# Request managed returns funding setup for a company
|
133
133
|
#
|
@@ -153,7 +153,7 @@ module AvaTax
|
|
153
153
|
# @param model [Object] The funding initialization request
|
154
154
|
# @return [Object]
|
155
155
|
def create_funding_request(id, model, options={}) path = "/api/v2/companies/#{id}/funding/setup"
|
156
|
-
post(path, model, options, "22.
|
156
|
+
post(path, model, options, "22.10.0") end
|
157
157
|
|
158
158
|
# Delete a single company
|
159
159
|
#
|
@@ -166,7 +166,7 @@ module AvaTax
|
|
166
166
|
# @param id [Integer] The ID of the company you wish to delete.
|
167
167
|
# @return [ErrorDetail[]]
|
168
168
|
def delete_company(id) path = "/api/v2/companies/#{id}"
|
169
|
-
delete(path, {}, "22.
|
169
|
+
delete(path, {}, "22.10.0") end
|
170
170
|
|
171
171
|
# Delete a single company parameter
|
172
172
|
#
|
@@ -185,7 +185,7 @@ module AvaTax
|
|
185
185
|
# @param id [Integer] The parameter id
|
186
186
|
# @return [ErrorDetail[]]
|
187
187
|
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
188
|
-
delete(path, {}, "22.
|
188
|
+
delete(path, {}, "22.10.0") end
|
189
189
|
|
190
190
|
# Check the funding configuration of a company
|
191
191
|
#
|
@@ -202,7 +202,7 @@ module AvaTax
|
|
202
202
|
# @param companyId [Integer] The unique identifier of the company
|
203
203
|
# @return [Object]
|
204
204
|
def funding_configuration_by_company(companyId) path = "/api/v2/companies/#{companyId}/funding/configuration"
|
205
|
-
get(path, {}, "22.
|
205
|
+
get(path, {}, "22.10.0") end
|
206
206
|
|
207
207
|
# Check the funding configuration of a company
|
208
208
|
#
|
@@ -220,7 +220,7 @@ module AvaTax
|
|
220
220
|
# @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
|
221
221
|
# @return [FundingConfigurationModel[]]
|
222
222
|
def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
|
223
|
-
get(path, options, "22.
|
223
|
+
get(path, options, "22.10.0") end
|
224
224
|
|
225
225
|
# Retrieve a single company
|
226
226
|
#
|
@@ -246,7 +246,7 @@ module AvaTax
|
|
246
246
|
# @param include [String] OPTIONAL: A comma separated list of special fetch options. * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
|
247
247
|
# @return [Object]
|
248
248
|
def get_company(id, options={}) path = "/api/v2/companies/#{id}"
|
249
|
-
get(path, options, "22.
|
249
|
+
get(path, options, "22.10.0") end
|
250
250
|
|
251
251
|
# Get configuration settings for this company
|
252
252
|
#
|
@@ -270,7 +270,7 @@ module AvaTax
|
|
270
270
|
# @param id [Integer]
|
271
271
|
# @return [CompanyConfigurationModel[]]
|
272
272
|
def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
|
273
|
-
get(path, {}, "22.
|
273
|
+
get(path, {}, "22.10.0") end
|
274
274
|
|
275
275
|
# Retrieve a single company parameter
|
276
276
|
#
|
@@ -290,7 +290,7 @@ module AvaTax
|
|
290
290
|
# @param id [Integer]
|
291
291
|
# @return [Object]
|
292
292
|
def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
293
|
-
get(path, {}, "22.
|
293
|
+
get(path, {}, "22.10.0") end
|
294
294
|
|
295
295
|
# Get this company's filing status
|
296
296
|
#
|
@@ -316,7 +316,7 @@ module AvaTax
|
|
316
316
|
# @param id [Integer]
|
317
317
|
# @return [String]
|
318
318
|
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
319
|
-
get(path, {}, "22.
|
319
|
+
get(path, {}, "22.10.0") end
|
320
320
|
|
321
321
|
# Get ACH entry detail report for company and period
|
322
322
|
#
|
@@ -335,7 +335,7 @@ module AvaTax
|
|
335
335
|
# @param periodmonth [Integer] The period month
|
336
336
|
# @return [ACHEntryDetailModel[]]
|
337
337
|
def list_a_c_h_entry_details_for_company(id, periodyear, periodmonth) path = "/api/v2/companies/#{id}/paymentdetails/#{periodyear}/#{periodmonth}"
|
338
|
-
get(path, {}, "22.
|
338
|
+
get(path, {}, "22.10.0") end
|
339
339
|
|
340
340
|
# Retrieve parameters for a company
|
341
341
|
#
|
@@ -361,7 +361,7 @@ module AvaTax
|
|
361
361
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
362
362
|
# @return [FetchResult]
|
363
363
|
def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
|
364
|
-
get(path, options, "22.
|
364
|
+
get(path, options, "22.10.0") end
|
365
365
|
|
366
366
|
# Check managed returns funding status for a company
|
367
367
|
#
|
@@ -378,7 +378,7 @@ module AvaTax
|
|
378
378
|
# @param id [Integer] The unique identifier of the company
|
379
379
|
# @return [FundingStatusModel[]]
|
380
380
|
def list_funding_requests_by_company(id) path = "/api/v2/companies/#{id}/funding"
|
381
|
-
get(path, {}, "22.
|
381
|
+
get(path, {}, "22.10.0") end
|
382
382
|
|
383
383
|
# Retrieve a list of MRS Companies with account
|
384
384
|
#
|
@@ -392,7 +392,7 @@ module AvaTax
|
|
392
392
|
# Swagger Name: AvaTaxClient
|
393
393
|
# @return [FetchResult]
|
394
394
|
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
395
|
-
get(path, {}, "22.
|
395
|
+
get(path, {}, "22.10.0") end
|
396
396
|
|
397
397
|
# Retrieve all companies
|
398
398
|
#
|
@@ -425,7 +425,7 @@ module AvaTax
|
|
425
425
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
426
426
|
# @return [FetchResult]
|
427
427
|
def query_companies(options={}) path = "/api/v2/companies"
|
428
|
-
get(path, options, "22.
|
428
|
+
get(path, options, "22.10.0") end
|
429
429
|
|
430
430
|
# Change configuration settings for this company
|
431
431
|
#
|
@@ -450,7 +450,7 @@ module AvaTax
|
|
450
450
|
# @param model [CompanyConfigurationModel[]]
|
451
451
|
# @return [CompanyConfigurationModel[]]
|
452
452
|
def set_company_configuration(id, model) path = "/api/v2/companies/#{id}/configuration"
|
453
|
-
post(path, model, {}, "22.
|
453
|
+
post(path, model, {}, "22.10.0") end
|
454
454
|
|
455
455
|
# Update a single company
|
456
456
|
#
|
@@ -474,7 +474,7 @@ module AvaTax
|
|
474
474
|
# @param model [Object] The company object you wish to update.
|
475
475
|
# @return [Object]
|
476
476
|
def update_company(id, model) path = "/api/v2/companies/#{id}"
|
477
|
-
put(path, model, {}, "22.
|
477
|
+
put(path, model, {}, "22.10.0") end
|
478
478
|
|
479
479
|
# Update a company parameter
|
480
480
|
#
|
@@ -495,7 +495,7 @@ module AvaTax
|
|
495
495
|
# @param model [Object] The company parameter object you wish to update.
|
496
496
|
# @return [Object]
|
497
497
|
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
498
|
-
put(path, model, {}, "22.
|
498
|
+
put(path, model, {}, "22.10.0") end
|
499
499
|
end
|
500
500
|
end
|
501
501
|
end
|