avatax 21.12.0 → 22.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +55 -55
- data/.rspec +1 -1
- data/.travis.yml +18 -18
- data/.vs/VSWorkspaceState.json +5 -5
- data/.yardopts +4 -4
- data/Gemfile +2 -2
- data/LICENSE +201 -201
- data/README.md +98 -98
- data/Rakefile +9 -9
- data/avatax.gemspec +38 -38
- data/example/avatax.rb +47 -47
- data/example/credentials.example.yaml +5 -5
- data/lib/avatax/api.rb +27 -27
- 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 +40 -21
- 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 +75 -72
- data/lib/avatax/client/distancethresholds.rb +6 -6
- data/lib/avatax/client/ecms.rb +73 -73
- data/lib/avatax/client/ecommercetoken.rb +2 -2
- data/lib/avatax/client/errortransactions.rb +61 -61
- data/lib/avatax/client/filingcalendars.rb +3 -3
- data/lib/avatax/client/filings.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 +165 -28
- 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/onboarding.rb +55 -55
- data/lib/avatax/client/pointofsale.rb +21 -21
- data/lib/avatax/client/provisioning.rb +2 -2
- data/lib/avatax/client/registrar.rb +10 -21
- data/lib/avatax/client/reports.rb +4 -4
- data/lib/avatax/client/settings.rb +6 -6
- data/lib/avatax/client/shippingverification.rb +25 -9
- 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/taxprofiles.rb +42 -42
- data/lib/avatax/client/taxrules.rb +6 -6
- data/lib/avatax/client/transactions.rb +22 -23
- 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 +37 -37
- data/lib/avatax/configuration.rb +76 -76
- data/lib/avatax/connection.rb +49 -49
- data/lib/avatax/request.rb +51 -50
- data/lib/avatax/version.rb +3 -3
- data/lib/avatax.rb +26 -26
- data/spec/avatax/client/accounts_spec.rb +13 -13
- data/spec/avatax/client/transactions_spec.rb +80 -80
- data/spec/avatax/request_spec.rb +25 -25
- data/spec/avatax_spec.rb +45 -45
- data/spec/credentials.yaml.example +4 -4
- data/spec/fixtures/accounts.json +15 -15
- data/spec/spec_helper.rb +27 -27
- metadata +6 -13
@@ -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, {}, "
|
29
|
+
post(path, {}, "22.3.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, {}, "
|
61
|
+
post(path, model, {}, "22.3.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, {}, "
|
91
|
+
post(path, model, {}, "22.3.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, {}, "
|
114
|
+
delete(path, {}, "22.3.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, {}, "
|
129
|
+
get(path, {}, "22.3.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, {}, "
|
157
|
+
get(path, {}, "22.3.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, "
|
195
|
+
get(path, options, "22.3.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, "
|
229
|
+
get(path, options, "22.3.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, {}, "
|
34
|
+
post(path, model, {}, "22.3.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, "
|
65
|
+
get(path, options, "22.3.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, "
|
98
|
+
get(path, options, "22.3.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, "
|
40
|
+
post(path, model, options, "22.3.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, {}, "
|
67
|
+
delete(path, {}, "22.3.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, "
|
97
|
+
get(path, options, "22.3.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, "
|
129
|
+
get(path, options, "22.3.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, {}, "
|
149
|
+
get(path, {}, "22.3.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, {}, "
|
178
|
+
post(path, model, {}, "22.3.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, {}, "
|
208
|
+
post(path, model, {}, "22.3.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, {}, "
|
236
|
+
get(path, {}, "22.3.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, "
|
265
|
+
get(path, options, "22.3.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, "
|
300
|
+
get(path, options, "22.3.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, {}, "
|
322
|
+
post(path, {}, "22.3.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, {}, "
|
351
|
+
post(path, model, {}, "22.3.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, {}, "
|
382
|
+
post(path, model, {}, "22.3.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, {}, "
|
408
|
+
put(path, model, {}, "22.3.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, {}, "
|
437
|
+
post(path, {}, "22.3.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, {}, "
|
39
|
+
get(path, {}, "22.3.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, {}, "
|
65
|
+
post(path, model, {}, "22.3.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, {}, "
|
89
|
+
post(path, model, {}, "22.3.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, {}, "
|
106
|
+
post(path, model, {}, "22.3.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, {}, "
|
130
|
+
post(path, model, {}, "22.3.0") end
|
131
131
|
|
132
132
|
# Request managed returns funding setup for a company
|
133
133
|
#
|
@@ -151,7 +151,7 @@ module AvaTax
|
|
151
151
|
# @param model [Object] The funding initialization request
|
152
152
|
# @return [Object]
|
153
153
|
def create_funding_request(id, model) path = "/api/v2/companies/#{id}/funding/setup"
|
154
|
-
post(path, model, {}, "
|
154
|
+
post(path, model, {}, "22.3.0") end
|
155
155
|
|
156
156
|
# Delete a single company
|
157
157
|
#
|
@@ -164,7 +164,7 @@ module AvaTax
|
|
164
164
|
# @param id [Integer] The ID of the company you wish to delete.
|
165
165
|
# @return [ErrorDetail[]]
|
166
166
|
def delete_company(id) path = "/api/v2/companies/#{id}"
|
167
|
-
delete(path, {}, "
|
167
|
+
delete(path, {}, "22.3.0") end
|
168
168
|
|
169
169
|
# Delete a single company parameter
|
170
170
|
#
|
@@ -183,7 +183,7 @@ module AvaTax
|
|
183
183
|
# @param id [Integer] The parameter id
|
184
184
|
# @return [ErrorDetail[]]
|
185
185
|
def delete_company_parameter(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
186
|
-
delete(path, {}, "
|
186
|
+
delete(path, {}, "22.3.0") end
|
187
187
|
|
188
188
|
# Check the funding configuration of a company
|
189
189
|
#
|
@@ -200,7 +200,7 @@ module AvaTax
|
|
200
200
|
# @param companyId [Integer] The unique identifier of the company
|
201
201
|
# @return [Object]
|
202
202
|
def funding_configuration_by_company(companyId) path = "/api/v2/companies/#{companyId}/funding/configuration"
|
203
|
-
get(path, {}, "
|
203
|
+
get(path, {}, "22.3.0") end
|
204
204
|
|
205
205
|
# Check the funding configuration of a company
|
206
206
|
#
|
@@ -218,7 +218,7 @@ module AvaTax
|
|
218
218
|
# @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
|
219
219
|
# @return [FundingConfigurationModel[]]
|
220
220
|
def funding_configurations_by_company_and_currency(companyId, options={}) path = "/api/v2/companies/#{companyId}/funding/configurations"
|
221
|
-
get(path, options, "
|
221
|
+
get(path, options, "22.3.0") end
|
222
222
|
|
223
223
|
# Retrieve a single company
|
224
224
|
#
|
@@ -244,7 +244,7 @@ module AvaTax
|
|
244
244
|
# @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.
|
245
245
|
# @return [Object]
|
246
246
|
def get_company(id, options={}) path = "/api/v2/companies/#{id}"
|
247
|
-
get(path, options, "
|
247
|
+
get(path, options, "22.3.0") end
|
248
248
|
|
249
249
|
# Get configuration settings for this company
|
250
250
|
#
|
@@ -268,7 +268,7 @@ module AvaTax
|
|
268
268
|
# @param id [Integer]
|
269
269
|
# @return [CompanyConfigurationModel[]]
|
270
270
|
def get_company_configuration(id) path = "/api/v2/companies/#{id}/configuration"
|
271
|
-
get(path, {}, "
|
271
|
+
get(path, {}, "22.3.0") end
|
272
272
|
|
273
273
|
# Retrieve a single company parameter
|
274
274
|
#
|
@@ -288,7 +288,7 @@ module AvaTax
|
|
288
288
|
# @param id [Integer]
|
289
289
|
# @return [Object]
|
290
290
|
def get_company_parameter_detail(companyId, id) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
291
|
-
get(path, {}, "
|
291
|
+
get(path, {}, "22.3.0") end
|
292
292
|
|
293
293
|
# Get this company's filing status
|
294
294
|
#
|
@@ -314,7 +314,26 @@ module AvaTax
|
|
314
314
|
# @param id [Integer]
|
315
315
|
# @return [String]
|
316
316
|
def get_filing_status(id) path = "/api/v2/companies/#{id}/filingstatus"
|
317
|
-
get(path, {}, "
|
317
|
+
get(path, {}, "22.3.0") end
|
318
|
+
|
319
|
+
# Get ACH entry detail report for company and period
|
320
|
+
#
|
321
|
+
# This API is available by invitation only.
|
322
|
+
# Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
|
323
|
+
# Returns a list of ACH entry details for the given company and period.
|
324
|
+
# Each object in the result is an ach entry trace record for a payment made on behalf of this company.
|
325
|
+
#
|
326
|
+
# ### Security Policies
|
327
|
+
#
|
328
|
+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
|
329
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
330
|
+
# Swagger Name: AvaTaxClient
|
331
|
+
# @param id [Integer] The unique identifier of the company
|
332
|
+
# @param periodyear [Integer] The period year
|
333
|
+
# @param periodmonth [Integer] The period month
|
334
|
+
# @return [ACHEntryDetailModel[]]
|
335
|
+
def list_a_c_h_entry_details_for_company(id, periodyear, periodmonth) path = "/api/v2/companies/#{id}/paymentdetails/#{periodyear}/#{periodmonth}"
|
336
|
+
get(path, {}, "22.3.0") end
|
318
337
|
|
319
338
|
# Retrieve parameters for a company
|
320
339
|
#
|
@@ -340,7 +359,7 @@ module AvaTax
|
|
340
359
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
341
360
|
# @return [FetchResult]
|
342
361
|
def list_company_parameter_details(companyId, options={}) path = "/api/v2/companies/#{companyId}/parameters"
|
343
|
-
get(path, options, "
|
362
|
+
get(path, options, "22.3.0") end
|
344
363
|
|
345
364
|
# Check managed returns funding status for a company
|
346
365
|
#
|
@@ -357,7 +376,7 @@ module AvaTax
|
|
357
376
|
# @param id [Integer] The unique identifier of the company
|
358
377
|
# @return [FundingStatusModel[]]
|
359
378
|
def list_funding_requests_by_company(id) path = "/api/v2/companies/#{id}/funding"
|
360
|
-
get(path, {}, "
|
379
|
+
get(path, {}, "22.3.0") end
|
361
380
|
|
362
381
|
# Retrieve a list of MRS Companies with account
|
363
382
|
#
|
@@ -371,7 +390,7 @@ module AvaTax
|
|
371
390
|
# Swagger Name: AvaTaxClient
|
372
391
|
# @return [FetchResult]
|
373
392
|
def list_mrs_companies() path = "/api/v2/companies/mrs"
|
374
|
-
get(path, {}, "
|
393
|
+
get(path, {}, "22.3.0") end
|
375
394
|
|
376
395
|
# Retrieve all companies
|
377
396
|
#
|
@@ -404,7 +423,7 @@ module AvaTax
|
|
404
423
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
405
424
|
# @return [FetchResult]
|
406
425
|
def query_companies(options={}) path = "/api/v2/companies"
|
407
|
-
get(path, options, "
|
426
|
+
get(path, options, "22.3.0") end
|
408
427
|
|
409
428
|
# Change configuration settings for this company
|
410
429
|
#
|
@@ -429,7 +448,7 @@ module AvaTax
|
|
429
448
|
# @param model [CompanyConfigurationModel[]]
|
430
449
|
# @return [CompanyConfigurationModel[]]
|
431
450
|
def set_company_configuration(id, model) path = "/api/v2/companies/#{id}/configuration"
|
432
|
-
post(path, model, {}, "
|
451
|
+
post(path, model, {}, "22.3.0") end
|
433
452
|
|
434
453
|
# Update a single company
|
435
454
|
#
|
@@ -453,7 +472,7 @@ module AvaTax
|
|
453
472
|
# @param model [Object] The company object you wish to update.
|
454
473
|
# @return [Object]
|
455
474
|
def update_company(id, model) path = "/api/v2/companies/#{id}"
|
456
|
-
put(path, model, {}, "
|
475
|
+
put(path, model, {}, "22.3.0") end
|
457
476
|
|
458
477
|
# Update a company parameter
|
459
478
|
#
|
@@ -474,7 +493,7 @@ module AvaTax
|
|
474
493
|
# @param model [Object] The company parameter object you wish to update.
|
475
494
|
# @return [Object]
|
476
495
|
def update_company_parameter_detail(companyId, id, model) path = "/api/v2/companies/#{companyId}/parameters/#{id}"
|
477
|
-
put(path, model, {}, "
|
496
|
+
put(path, model, {}, "22.3.0") end
|
478
497
|
end
|
479
498
|
end
|
480
499
|
end
|
@@ -21,7 +21,7 @@ module AvaTax
|
|
21
21
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
22
22
|
# @return [Object]
|
23
23
|
def query_tax_authority_jurisdiction_rates(options={}) path = "/api/v2/compliance/taxauthorityjurisdictionrates"
|
24
|
-
get(path, options, "
|
24
|
+
get(path, options, "22.3.0") end
|
25
25
|
end
|
26
26
|
end
|
27
27
|
end
|
@@ -17,7 +17,7 @@ module AvaTax
|
|
17
17
|
# @param model [ContactModel[]] The contacts you wish to create.
|
18
18
|
# @return [ContactModel[]]
|
19
19
|
def create_contacts(companyId, model) path = "/api/v2/companies/#{companyId}/contacts"
|
20
|
-
post(path, model, {}, "
|
20
|
+
post(path, model, {}, "22.3.0") end
|
21
21
|
|
22
22
|
# Delete a single contact
|
23
23
|
#
|
@@ -31,7 +31,7 @@ module AvaTax
|
|
31
31
|
# @param id [Integer] The ID of the contact you wish to delete.
|
32
32
|
# @return [ErrorDetail[]]
|
33
33
|
def delete_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
34
|
-
delete(path, {}, "
|
34
|
+
delete(path, {}, "22.3.0") end
|
35
35
|
|
36
36
|
# Retrieve a single contact
|
37
37
|
#
|
@@ -47,7 +47,7 @@ module AvaTax
|
|
47
47
|
# @param id [Integer] The primary key of this contact
|
48
48
|
# @return [Object]
|
49
49
|
def get_contact(companyId, id) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
50
|
-
get(path, {}, "
|
50
|
+
get(path, {}, "22.3.0") end
|
51
51
|
|
52
52
|
# Retrieve contacts for this company
|
53
53
|
#
|
@@ -67,7 +67,7 @@ module AvaTax
|
|
67
67
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
68
68
|
# @return [FetchResult]
|
69
69
|
def list_contacts_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/contacts"
|
70
|
-
get(path, options, "
|
70
|
+
get(path, options, "22.3.0") end
|
71
71
|
|
72
72
|
# Retrieve all contacts
|
73
73
|
#
|
@@ -88,7 +88,7 @@ module AvaTax
|
|
88
88
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
89
89
|
# @return [FetchResult]
|
90
90
|
def query_contacts(options={}) path = "/api/v2/contacts"
|
91
|
-
get(path, options, "
|
91
|
+
get(path, options, "22.3.0") end
|
92
92
|
|
93
93
|
# Update a single contact
|
94
94
|
#
|
@@ -107,7 +107,7 @@ module AvaTax
|
|
107
107
|
# @param model [Object] The contact you wish to update.
|
108
108
|
# @return [Object]
|
109
109
|
def update_contact(companyId, id, model) path = "/api/v2/companies/#{companyId}/contacts/#{id}"
|
110
|
-
put(path, model, {}, "
|
110
|
+
put(path, model, {}, "22.3.0") end
|
111
111
|
end
|
112
112
|
end
|
113
113
|
end
|
@@ -30,7 +30,7 @@ module AvaTax
|
|
30
30
|
# @param model [CustomerModel[]] The list of customer objects to be created
|
31
31
|
# @return [CustomerModel[]]
|
32
32
|
def create_customers(companyId, model) path = "/api/v2/companies/#{companyId}/customers"
|
33
|
-
post(path, model, {}, "
|
33
|
+
post(path, model, {}, "22.3.0") end
|
34
34
|
|
35
35
|
# Delete a customer record
|
36
36
|
#
|
@@ -56,7 +56,7 @@ module AvaTax
|
|
56
56
|
# @param customerCode [String] The unique code representing this customer
|
57
57
|
# @return [Object]
|
58
58
|
def delete_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
|
59
|
-
delete(path, {}, "
|
59
|
+
delete(path, {}, "22.3.0") end
|
60
60
|
|
61
61
|
# Retrieve a single customer
|
62
62
|
#
|
@@ -89,7 +89,7 @@ module AvaTax
|
|
89
89
|
# @param include [String] Specify optional additional objects to include in this fetch request
|
90
90
|
# @return [Object]
|
91
91
|
def get_customer(companyId, customerCode, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
|
92
|
-
get(path, options, "
|
92
|
+
get(path, options, "22.3.0") end
|
93
93
|
|
94
94
|
# Link attributes to a customer
|
95
95
|
#
|
@@ -119,7 +119,7 @@ module AvaTax
|
|
119
119
|
# @param model [CustomerAttributeModel[]] The list of attributes to link to the customer.
|
120
120
|
# @return [FetchResult]
|
121
121
|
def link_attributes_to_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/link"
|
122
|
-
put(path, model, {}, "
|
122
|
+
put(path, model, {}, "22.3.0") end
|
123
123
|
|
124
124
|
# Link certificates to a customer
|
125
125
|
#
|
@@ -146,7 +146,7 @@ module AvaTax
|
|
146
146
|
# @param model [Object] The list of certificates to link to this customer
|
147
147
|
# @return [FetchResult]
|
148
148
|
def link_certificates_to_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/link"
|
149
|
-
post(path, model, {}, "
|
149
|
+
post(path, model, {}, "22.3.0") end
|
150
150
|
|
151
151
|
# Link two customer records together
|
152
152
|
#
|
@@ -174,7 +174,7 @@ module AvaTax
|
|
174
174
|
# @param model [Object] A list of information about ship-to customers to link to this bill-to customer.
|
175
175
|
# @return [Object]
|
176
176
|
def link_ship_to_customers_to_bill_customer(companyId, code, model) path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
|
177
|
-
post(path, model, {}, "
|
177
|
+
post(path, model, {}, "22.3.0") end
|
178
178
|
|
179
179
|
# Retrieve a customer's attributes
|
180
180
|
#
|
@@ -203,7 +203,7 @@ module AvaTax
|
|
203
203
|
# @param customerCode [String] The unique code representing the current customer
|
204
204
|
# @return [FetchResult]
|
205
205
|
def list_attributes_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes"
|
206
|
-
get(path, {}, "
|
206
|
+
get(path, {}, "22.3.0") end
|
207
207
|
|
208
208
|
# List certificates linked to a customer
|
209
209
|
#
|
@@ -234,7 +234,7 @@ module AvaTax
|
|
234
234
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
235
235
|
# @return [FetchResult]
|
236
236
|
def list_certificates_for_customer(companyId, customerCode, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
|
237
|
-
get(path, options, "
|
237
|
+
get(path, options, "22.3.0") end
|
238
238
|
|
239
239
|
# List valid certificates for a location
|
240
240
|
#
|
@@ -265,7 +265,7 @@ module AvaTax
|
|
265
265
|
# @param region [String] Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.
|
266
266
|
# @return [Object]
|
267
267
|
def list_valid_certificates_for_customer(companyId, customerCode, country, region) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/#{country}/#{region}"
|
268
|
-
get(path, {}, "
|
268
|
+
get(path, {}, "22.3.0") end
|
269
269
|
|
270
270
|
# List all customers for this company
|
271
271
|
#
|
@@ -300,7 +300,7 @@ module AvaTax
|
|
300
300
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
301
301
|
# @return [FetchResult]
|
302
302
|
def query_customers(companyId, options={}) path = "/api/v2/companies/#{companyId}/customers"
|
303
|
-
get(path, options, "
|
303
|
+
get(path, options, "22.3.0") end
|
304
304
|
|
305
305
|
# Unlink attributes from a customer
|
306
306
|
#
|
@@ -330,7 +330,7 @@ module AvaTax
|
|
330
330
|
# @param model [CustomerAttributeModel[]] The list of attributes to unlink from the customer.
|
331
331
|
# @return [FetchResult]
|
332
332
|
def unlink_attributes_from_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/unlink"
|
333
|
-
put(path, model, {}, "
|
333
|
+
put(path, model, {}, "22.3.0") end
|
334
334
|
|
335
335
|
# Unlink certificates from a customer
|
336
336
|
#
|
@@ -357,7 +357,7 @@ module AvaTax
|
|
357
357
|
# @param model [Object] The list of certificates to link to this customer
|
358
358
|
# @return [FetchResult]
|
359
359
|
def unlink_certificates_from_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/unlink"
|
360
|
-
post(path, model, {}, "
|
360
|
+
post(path, model, {}, "22.3.0") end
|
361
361
|
|
362
362
|
# Update a single customer
|
363
363
|
#
|
@@ -384,7 +384,7 @@ module AvaTax
|
|
384
384
|
# @param model [Object] The new customer model that will replace the existing record at this URL
|
385
385
|
# @return [Object]
|
386
386
|
def update_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
|
387
|
-
put(path, model, {}, "
|
387
|
+
put(path, model, {}, "22.3.0") end
|
388
388
|
end
|
389
389
|
end
|
390
390
|
end
|