avatax 26.6.0 → 26.7.3

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bb79a9f4603321ed83713aa67ec0e32e37f649d8a13eb5d7a57f5b97c001c55f
4
- data.tar.gz: fe20a61f2dfcef13b8fe611c40778b3d31933dcbfc7128fb6c4c9ad42b155f72
3
+ metadata.gz: 503a067927399814061c9c16324bbe9e28035dceedcaa696981647c843e9bea8
4
+ data.tar.gz: 27f1dbf064ddea4929a17da85820eec8bbe7bb673d9448a62ca6127a51a1fffd
5
5
  SHA512:
6
- metadata.gz: 2bbc3af857171c4380fd509e5e95f66a8a6c6cc4b0d23757e7dca79e29e48fcb56a72b969918341a987fa59599fc28d399b2163cbc50ede94862bf639fefa7be
7
- data.tar.gz: d1c3d9e022a9a6c9aaf5c32a7762633b868a9157537f5b7b546831d3aef59813c2ed0c00ee8fdac824ad350b1c2c0190e533c38317bb29df4f36646ded7093e0
6
+ metadata.gz: 667efbac861fd6b5aec23b846d71ad5c4ea5437e3129bf65f119494134141eba257bef4f5b1035ac20431cd9d37a49cc0548030aa3d5810e791f0538b3831131
7
+ data.tar.gz: b1e6de92a39be850eb7ddfe0a1f7486ce53774dbc6e64dccad525d0ec07f8400cbd34462023abec2da16ad05b96862f0af7fa777e0abc572a4aafd562f5dedeb
@@ -133,6 +133,8 @@ module AvaTax
133
133
  # * attributes - Retrieves all attributes applied to the certificate.
134
134
  # * histories - Retrieves the certificate update history
135
135
  # * jobs - Retrieves the jobs for this certificate
136
+ # * jobs.phases - Retrieves the jobs along with their phases
137
+ # * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase
136
138
  # * logs - Retrieves the certificate log
137
139
  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
138
140
  # * custom_fields - Retrieves custom fields set for this certificate
@@ -150,7 +152,7 @@ module AvaTax
150
152
  # Swagger Name: AvaTaxClient
151
153
  # @param companyId [Integer] The ID number of the company that recorded this certificate
152
154
  # @param id [Integer] The unique ID number of this certificate
153
- # @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
155
+ # @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * jobs.phases - Retrieves the jobs along with their phases * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
154
156
  # @return [Object]
155
157
  def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
156
158
  get(path, options, AvaTax::VERSION) end
@@ -262,6 +264,37 @@ module AvaTax
262
264
  def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
263
265
  get(path, {}, AvaTax::VERSION) end
264
266
 
267
+ # List the certificate tax-type hierarchy available to this company
268
+ #
269
+ # Returns the TPS multi-tax type hierarchy that is applicable when configuring exemption
270
+ # certificates for the given country. The returned tax types can be used to populate
271
+ # `taxTypeMappings` entries on a certificate jurisdiction via POST / PUT certificate.
272
+ #
273
+ # This endpoint is scoped to the certificate (CertCapture) domain and does not return the
274
+ # generic AvaTax tax-type catalog. For the generic catalog see the `Definitions` APIs.
275
+ #
276
+ # `country` is a mandatory query parameter.
277
+ #
278
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
279
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
280
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
281
+ # certificate storage for this company, call `RequestCertificateSetup`.
282
+ #
283
+ # ### Security Policies
284
+ #
285
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
286
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
287
+ # Swagger Name: AvaTaxClient
288
+ # @param companyId [Integer] The ID number of the company
289
+ # @param country [String] Required. ISO-2 country code used to filter the tax-type hierarchy (e.g., "US").
290
+ # @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:* taxTypeId, country, taxSubTypeDetails
291
+ # @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.
292
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
293
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
294
+ # @return [FetchResult]
295
+ def list_certificate_tax_types(companyId, options={}) path = "/api/v2/companies/#{companyId}/certificates/taxtypes"
296
+ get(path, options, AvaTax::VERSION) end
297
+
265
298
  # List customers linked to this certificate
266
299
  #
267
300
  # List all customers linked to this certificate.
@@ -355,6 +388,8 @@ module AvaTax
355
388
  # * attributes - Retrieves all attributes applied to the certificate.
356
389
  # * histories - Retrieves the certificate update history
357
390
  # * jobs - Retrieves the jobs for this certificate
391
+ # * jobs.phases - Retrieves the jobs along with their phases
392
+ # * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase
358
393
  # * logs - Retrieves the certificate log
359
394
  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
360
395
  # * custom_fields - Retrieves custom fields set for this certificate
@@ -371,8 +406,8 @@ module AvaTax
371
406
  # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
372
407
  # Swagger Name: AvaTaxClient
373
408
  # @param companyId [Integer] The ID number of the company to search
374
- # @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
375
- # @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:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages
409
+ # @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * jobs.phases - Retrieves the jobs along with their phases * jobs.tasks - Retrieves the jobs along with their phases and the tasks within each phase * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
410
+ # @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:* exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
376
411
  # @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.
377
412
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
378
413
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -3,6 +3,27 @@ module AvaTax
3
3
  module Customers
4
4
 
5
5
 
6
+ # Add ship-to states to a customer
7
+ #
8
+ # Adds one or more ship-to states to the specified customer.
9
+ #
10
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
11
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
12
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
13
+ # certificate storage for this company, call `RequestCertificateSetup`.
14
+ #
15
+ # ### Security Policies
16
+ #
17
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
18
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
19
+ # Swagger Name: AvaTaxClient
20
+ # @param companyId [Integer] The unique ID number of the company that recorded this customer
21
+ # @param customerCode [String] The unique code representing this customer
22
+ # @param model [StateModel[]] The list of ship-to states to add to this customer
23
+ # @return [FetchResult]
24
+ def add_ship_to_states_for_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/shiptostate"
25
+ post(path, model, {}, AvaTax::VERSION) end
26
+
6
27
  # Create customers for this company
7
28
  #
8
29
  # Create one or more customers for this company.
@@ -276,7 +297,7 @@ module AvaTax
276
297
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
277
298
  # @param customerCode [String] The unique code representing this customer
278
299
  # @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
279
- # @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:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages
300
+ # @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:* exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
280
301
  # @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.
281
302
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
282
303
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -324,6 +345,26 @@ module AvaTax
324
345
  def list_in_active_certificates_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/inactive"
325
346
  get(path, {}, AvaTax::VERSION) end
326
347
 
348
+ # List ship-to states linked to a customer
349
+ #
350
+ # Retrieves the ship-to states associated with the specified customer.
351
+ #
352
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
353
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
354
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
355
+ # certificate storage for this company, call `RequestCertificateSetup`.
356
+ #
357
+ # ### Security Policies
358
+ #
359
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
360
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
361
+ # Swagger Name: AvaTaxClient
362
+ # @param companyId [Integer] The unique ID number of the company that recorded this customer
363
+ # @param customerCode [String] The unique code representing this customer
364
+ # @return [FetchResult]
365
+ def list_ship_to_states_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/shiptostate"
366
+ get(path, {}, AvaTax::VERSION) end
367
+
327
368
  # List valid certificates for a location
328
369
  #
329
370
  # List valid certificates linked to a customer in a particular country and region.
@@ -398,6 +439,27 @@ module AvaTax
398
439
  def query_customers(companyId, options={}) path = "/api/v2/companies/#{companyId}/customers"
399
440
  get(path, options, AvaTax::VERSION) end
400
441
 
442
+ # Remove ship-to states from a customer
443
+ #
444
+ # Removes one or more ship-to states from the specified customer.
445
+ #
446
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
447
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
448
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
449
+ # certificate storage for this company, call `RequestCertificateSetup`.
450
+ #
451
+ # ### Security Policies
452
+ #
453
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
454
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
455
+ # Swagger Name: AvaTaxClient
456
+ # @param companyId [Integer] The unique ID number of the company that recorded this customer
457
+ # @param customerCode [String] The unique code representing this customer
458
+ # @param model [StateModel[]] The list of ship-to states to remove from this customer
459
+ # @return [FetchResult]
460
+ def remove_ship_to_states_for_customer(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/shiptostate"
461
+ delete(path, model, {}, AvaTax::VERSION) end
462
+
401
463
  # Unlink attributes from a customer
402
464
  #
403
465
  # Unlink one or many attributes from a customer.
@@ -365,6 +365,10 @@ module AvaTax
365
365
  # It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby
366
366
  # jurisdiction in AvaTax.
367
367
  #
368
+ # You can widen the search by supplying the optional `radius` parameter (in miles). Supported values are
369
+ # 5 (default), 10, 20, 30, and 40. If the desired tax region is not found at 5 miles, retry with a larger radius.
370
+ # This only affects tax-region retrieval for this request; it does not change tax calculation once a region is selected.
371
+ #
368
372
  # The results of this API call can be passed to the `CreateJurisdictionOverride` API call.
369
373
  # Swagger Name: AvaTaxClient
370
374
  # @param line1 [String] The first address line portion of this address.
@@ -374,6 +378,7 @@ module AvaTax
374
378
  # @param region [String] The region, state, or province code portion of this address.
375
379
  # @param postalCode [String] The postal code or zip code portion of this address.
376
380
  # @param country [String] The two-character ISO-3166 code of the country portion of this address.
381
+ # @param radius [Integer] Optional. The search radius in miles used to find nearby tax regions. Allowed values are 5, 10, 20, 30, and 40; when omitted the default of 5 miles is used. A larger radius widens the search for this request only and does not change the default behavior for other requests. Any other value is rejected with a validation error.
377
382
  # @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
378
383
  # @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.
379
384
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -3,32 +3,31 @@ module AvaTax
3
3
  module EcoNexusThreshold
4
4
 
5
5
 
6
- # List economic nexus threshold statuses for a company
6
+ # Get economic nexus threshold statuses for a company
7
7
  #
8
- # Returns precomputed economic nexus threshold statuses for a company, sourced from a cache
9
- # refreshed weekly from Snowflake.
8
+ # Returns precomputed economic nexus threshold statuses for a company, sourced from an in-memory
9
+ # cache refreshed periodically from Snowflake. All responses are served from cache;
10
+ # Snowflake is never queried on the request path.
10
11
  #
11
- # When the optional `region` query parameter is provided, only the matching jurisdiction row is included in `states`.
12
- # If no row exists for that company and region, `states` is an empty array (still 200 OK).
12
+ # When the optional `region` query parameter is provided, only the matching jurisdiction row
13
+ # is included in `states`. If no row exists for that company and region, `states` is
14
+ # an empty array (200 OK).
13
15
  #
14
- # TPS currently binds this filter as query parameter `state`; use the same value. If the public contract standardizes on `region`,
15
- # TPS or api-gateway should accept or rewrite `region` so filtering still applies.
16
+ # When `lastRefreshedAt` is absent from the response, the cache has not yet completed its
17
+ # first refresh; callers should treat absence as "cache freshness unknown".
16
18
  #
17
19
  # Production traffic is served by TPS; api-gateway should route this path to TPS.
18
20
  #
19
- # This endpoint requires the `NexusFetch` permission. If EcoNexus is not configured in TPS or the cache has not loaded, TPS returns 503.
21
+ # This endpoint requires the `NexusFetch` permission. If EcoNexus is not configured in TPS,
22
+ # a 503 is returned with no `Retry-After` (misconfiguration requires redeployment).
23
+ # If the cache is still initializing, a 503 is returned with `Retry-After: 300`.
20
24
  #
21
25
  # ### Security Policies
22
26
  #
23
27
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
24
28
  # Swagger Name: AvaTaxClient
25
29
  # @param companyId [Integer] The Avalara company identifier.
26
- # @param region [String] Optional two-letter US state/region postal code (case-insensitive), same meaning as the `state` column in the data store. When provided, `states` contains at most one item; if there is no data for that company and region, `states` is an empty array (200 OK).
27
- # @param include [String] Standard Avalara `$include` query option (see other v2 list APIs).
28
- # @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/).
29
- # @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.
30
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
31
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
30
+ # @param region [String] Optional two-letter US state postal code to filter results (case-insensitive). When provided, `states` contains at most one item; if there is no data for that company and region, `states` is an empty array (200 OK). Must be exactly two characters; otherwise returns 400. Matches the `region` field on each item in the response.
32
31
  # @return [Object]
33
32
  def get_eco_nexus_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/econexusthresholds"
34
33
  get(path, options, AvaTax::VERSION) end
@@ -16,7 +16,7 @@ module AvaTax
16
16
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
17
17
  # Swagger Name: AvaTaxClient
18
18
  # @param companyId [Integer] The ID of the company for which you want to create the registration.
19
- # @param model [Object] The webhook registration details to create.
19
+ # @param model [ItemReverseSyncRegistrationInputModel[]] The webhook registration details to create.
20
20
  # @return [Object]
21
21
  def create_reverse_sync_registration(companyId, model) path = "/api/v2/connector-sync/companies/#{companyId}/registrations"
22
22
  post(path, model, {}, AvaTax::VERSION) end
@@ -0,0 +1,197 @@
1
+ module AvaTax
2
+ class Client
3
+ module Jobs
4
+
5
+
6
+ # Create a new job for a company
7
+ #
8
+ # ### Security Policies
9
+ #
10
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
11
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
12
+ # Swagger Name: AvaTaxClient
13
+ # @param companyId [Integer] The unique ID number of the company
14
+ # @param model [Object] The job to create
15
+ # @return [Object]
16
+ def create_job(companyId, model) path = "/api/v2/companies/#{companyId}/jobs"
17
+ post(path, model, {}, AvaTax::VERSION) end
18
+
19
+ # Create a new phase on a job
20
+ #
21
+ # ### Security Policies
22
+ #
23
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
24
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
25
+ # Swagger Name: AvaTaxClient
26
+ # @param companyId [Integer] The unique ID number of the company
27
+ # @param jobId [Integer] The unique ID number of the job
28
+ # @param model [Object] The phase to create
29
+ # @return [Object]
30
+ def create_job_phase(companyId, jobId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases"
31
+ post(path, model, {}, AvaTax::VERSION) end
32
+
33
+ # Create a new task on a phase
34
+ #
35
+ # ### Security Policies
36
+ #
37
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
38
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
39
+ # Swagger Name: AvaTaxClient
40
+ # @param companyId [Integer] The unique ID number of the company
41
+ # @param jobId [Integer] The unique ID number of the job
42
+ # @param phaseId [Integer] The unique ID number of the phase
43
+ # @param model [Object] The task to create
44
+ # @return [Object]
45
+ def create_job_task(companyId, jobId, phaseId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}/tasks"
46
+ post(path, model, {}, AvaTax::VERSION) end
47
+
48
+ # Delete a job
49
+ #
50
+ # ### Security Policies
51
+ #
52
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
53
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
54
+ # Swagger Name: AvaTaxClient
55
+ # @param companyId [Integer] The unique ID number of the company
56
+ # @param id [Integer] The unique ID number of the job to delete
57
+ # @return [Object]
58
+ def delete_job(companyId, id) path = "/api/v2/companies/#{companyId}/jobs/#{id}"
59
+ delete(path, {}, AvaTax::VERSION) end
60
+
61
+ # Delete a phase from a job
62
+ #
63
+ # ### Security Policies
64
+ #
65
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
66
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
67
+ # Swagger Name: AvaTaxClient
68
+ # @param companyId [Integer] The unique ID number of the company
69
+ # @param jobId [Integer] The unique ID number of the job
70
+ # @param phaseId [Integer] The unique ID number of the phase to delete
71
+ # @return [Object]
72
+ def delete_job_phase(companyId, jobId, phaseId) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}"
73
+ delete(path, {}, AvaTax::VERSION) end
74
+
75
+ # Delete a task from a phase
76
+ #
77
+ # ### Security Policies
78
+ #
79
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
80
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
81
+ # Swagger Name: AvaTaxClient
82
+ # @param companyId [Integer] The unique ID number of the company
83
+ # @param jobId [Integer] The unique ID number of the job
84
+ # @param phaseId [Integer] The unique ID number of the phase
85
+ # @param taskId [Integer] The unique ID number of the task to delete
86
+ # @return [Object]
87
+ def delete_job_task(companyId, jobId, phaseId, taskId) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}/tasks/#{taskId}"
88
+ delete(path, {}, AvaTax::VERSION) end
89
+
90
+ # Retrieve a single job
91
+ #
92
+ # Retrieve a single job by its unique ID.
93
+ #
94
+ # A job represents construction or project work that exemption certificates can be associated with. Each
95
+ # job can contain one or more phases, and each phase can contain one or more tasks.
96
+ #
97
+ # You can use the `$include` parameter to fetch the following additional objects for expansion:
98
+ #
99
+ # * phases - Retrieves the list of phases for this job.
100
+ # * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases, so requesting `tasks` will also expand `phases`.
101
+ #
102
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
103
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
104
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
105
+ # certificate storage for this company, call `RequestCertificateSetup`.
106
+ #
107
+ # ### Security Policies
108
+ #
109
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
110
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
111
+ # Swagger Name: AvaTaxClient
112
+ # @param companyId [Integer] The unique ID number of the company
113
+ # @param id [Integer] The unique ID number of the job
114
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * phases - Retrieves the list of phases for this job. * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases, so requesting `tasks` will also expand `phases`.
115
+ # @return [Object]
116
+ def get_job(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/jobs/#{id}"
117
+ get(path, options, AvaTax::VERSION) end
118
+
119
+ # List all jobs for a company
120
+ #
121
+ # List all jobs recorded by a company.
122
+ #
123
+ # A job represents construction or project work that exemption certificates can be associated with. Each
124
+ # job can contain one or more phases, and each phase can contain one or more tasks.
125
+ #
126
+ # You can use the `$include` parameter to fetch the following additional objects for expansion:
127
+ #
128
+ # * phases - Retrieves the list of phases for each job.
129
+ # * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases, so requesting `tasks` will also expand `phases`.
130
+ #
131
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
132
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
133
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
134
+ # certificate storage for this company, call `RequestCertificateSetup`.
135
+ #
136
+ # ### Security Policies
137
+ #
138
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
139
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
140
+ # Swagger Name: AvaTaxClient
141
+ # @param companyId [Integer] The unique ID number of the company
142
+ # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * phases - Retrieves the list of phases for each job. * tasks - Retrieves the list of tasks within each phase. Tasks are nested under phases
143
+ # @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:* exposureZone, phases
144
+ # @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.
145
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
146
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
147
+ # @return [FetchResult]
148
+ def list_jobs(companyId, options={}) path = "/api/v2/companies/#{companyId}/jobs"
149
+ get(path, options, AvaTax::VERSION) end
150
+
151
+ # Update an existing job
152
+ #
153
+ # ### Security Policies
154
+ #
155
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
156
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
157
+ # Swagger Name: AvaTaxClient
158
+ # @param companyId [Integer] The unique ID number of the company
159
+ # @param id [Integer] The unique ID number of the job to update
160
+ # @param model [Object] The updated job data
161
+ # @return [Object]
162
+ def update_job(companyId, id, model) path = "/api/v2/companies/#{companyId}/jobs/#{id}"
163
+ put(path, model, {}, AvaTax::VERSION) end
164
+
165
+ # Update an existing phase on a job
166
+ #
167
+ # ### Security Policies
168
+ #
169
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
170
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
171
+ # Swagger Name: AvaTaxClient
172
+ # @param companyId [Integer] The unique ID number of the company
173
+ # @param jobId [Integer] The unique ID number of the job
174
+ # @param phaseId [Integer] The unique ID number of the phase
175
+ # @param model [Object] The updated phase data
176
+ # @return [Object]
177
+ def update_job_phase(companyId, jobId, phaseId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}"
178
+ put(path, model, {}, AvaTax::VERSION) end
179
+
180
+ # Update an existing task on a phase
181
+ #
182
+ # ### Security Policies
183
+ #
184
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
185
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
186
+ # Swagger Name: AvaTaxClient
187
+ # @param companyId [Integer] The unique ID number of the company
188
+ # @param jobId [Integer] The unique ID number of the job
189
+ # @param phaseId [Integer] The unique ID number of the phase
190
+ # @param taskId [Integer] The unique ID number of the task
191
+ # @param model [Object] The updated task data
192
+ # @return [Object]
193
+ def update_job_task(companyId, jobId, phaseId, taskId, model) path = "/api/v2/companies/#{companyId}/jobs/#{jobId}/phases/#{phaseId}/tasks/#{taskId}"
194
+ put(path, model, {}, AvaTax::VERSION) end
195
+ end
196
+ end
197
+ end
@@ -5,14 +5,26 @@ module AvaTax
5
5
 
6
6
  # Download an audit log report
7
7
  #
8
- # Downloads the file associated with an audit log report.
9
- # If the report is not yet complete, you will receive a `ReportNotFinished` error.
8
+ # This API downloads the file associated with an audit log report.
9
+ #
10
+ # If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
11
+ # use the `GetAuditLogReport` API.
12
+ #
13
+ # Reports are run on the server. When complete, the report file will be available for download
14
+ # for up to 30 days after completion. To run a report, you should follow these steps:
15
+ #
16
+ # * Begin a report by calling the report's ExportAuditLogs API.
17
+ # * In the result of the ExportAuditLogs API, you receive back a report's `id` value.
18
+ # * Check the status of a report by calling `GetAuditLogReport` and passing in the report's `id` value.
19
+ # * When a report's status is `Completed`, call `DownloadAuditLogReport` to retrieve the file.
20
+ #
21
+ # * We throttle this API. You can only call this API up to 5 times in a minute.
10
22
  #
11
23
  # ### Security Policies
12
24
  #
13
25
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
14
26
  # Swagger Name: AvaTaxClient
15
- # @param id [String] The unique ID of the audit log report
27
+ # @param id [String] The unique ID number of this report
16
28
  # @return [Object]
17
29
  def download_audit_log_report(id) path = "/api/v2/reports/exportauditlogs/#{id}/attachment"
18
30
  get(path, {}, AvaTax::VERSION) end
@@ -47,24 +59,59 @@ module AvaTax
47
59
  #
48
60
  # Begins running an `ExportAuditLogs` report task and returns the identity of the report.
49
61
  #
62
+ # Reports are run on the server. When complete, the report file will be available for download
63
+ # for up to 30 days after completion. To run a report, you should follow these steps:
64
+ #
65
+ # * Begin a report by calling the report's ExportAuditLogs API.
66
+ # * In the result of the ExportAuditLogs API, you receive a report's `id` value.
67
+ # * All reports with `InQueue` status are picked up by the report service and processed in the background.
68
+ # * Reports that are picked up by the report service will have an `InProgress` status.
69
+ # * Reports will be updated to `Completed` status when the report is ready for download.
70
+ # * Check the status of a report by calling `GetAuditLogReport` and passing in the report's `id` value.
71
+ # * When a report's status is `Completed`, call `DownloadAuditLogReport` to retrieve the file.
72
+ #
73
+ # The `ExportAuditLogs` report produces information about audit records within your account.
74
+ #
75
+ # The following `reportType` values are supported:
76
+ # * `audit` - Exports audit records for configuration changes. Requires `reportSubType` to specify the table name.
77
+ # * `audittransactionlogs` - Exports transaction audit logs.
78
+ #
79
+ # When `reportType` is `audit`, the `reportSubType` field supports the following valid table names:
80
+ # `NEXUS`, `USER`, `COMPANY`, `ACCOUNT`, `COMPANYLOCATION`, `ACCOUNTSETTING`, `COMPANYLOCATIONSETTING`,
81
+ # `COMPANYSETTING`, `TAXCODE`, `TAXRULE`, `ADDRESSSERVICECONFIG`, `AUDITADVANCEDRULE`, `COMPANYCONTACT`,
82
+ # `COMPANYLOCATIONPARAMETERDETAIL`, `COMPANYLOCATIONSETTINGCONFIG`, `COMPANYPARAMETERDETAIL`, `COMPANYRETURN`,
83
+ # `COMPANYRETURNSETTING`, `ITEM`, `SERVICE`, `EXEMPTCERT`, `AVACERTSERVICECONFIG`, `JURISDICTIONOVERRIDE`, `COSTCENTER`.
84
+ #
85
+ # Set `compression` to `GZIP` to reduce the size of the report file and increase download speed.
86
+ #
50
87
  # ### Security Policies
51
88
  #
52
89
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
53
90
  # Swagger Name: AvaTaxClient
54
- # @param model [Object] Options to filter the audit log export.
91
+ # @param model [Object] Options that may be configured to customize the report.
55
92
  # @return [ReportAuditLogResponseModel[]]
56
93
  def export_audit_logs(model) path = "/api/v2/reports/exportauditlogs"
57
94
  post(path, model, {}, AvaTax::VERSION) end
58
95
 
59
- # Get an audit log report by id
96
+ # Retrieve a single audit log report
60
97
  #
61
- # Retrieves the status and details of an audit log report task.
98
+ # Retrieve a single audit log report by its unique ID number.
99
+ #
100
+ # Reports are run on the server. When complete, the report file will be available for download
101
+ # for up to 30 days after completion. To run a report, you should follow these steps:
102
+ #
103
+ # * Begin a report by calling the report's ExportAuditLogs API.
104
+ # * In the result of the ExportAuditLogs API, you receive back a report's `id` value.
105
+ # * Check the status of a report by calling `GetAuditLogReport` and passing in the report's `id` value.
106
+ # * When a report's status is `Completed`, call `DownloadAuditLogReport` to retrieve the file.
107
+ #
108
+ # This API call returns information about audit log report types.
62
109
  #
63
110
  # ### Security Policies
64
111
  #
65
112
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
66
113
  # Swagger Name: AvaTaxClient
67
- # @param id [String] The unique ID of the audit log report
114
+ # @param id [String] The unique ID number of the report to retrieve
68
115
  # @return [Object]
69
116
  def get_audit_log_report(id) path = "/api/v2/reports/exportauditlogs/#{id}"
70
117
  get(path, {}, AvaTax::VERSION) end
@@ -107,7 +154,7 @@ module AvaTax
107
154
  #
108
155
  # Set `compression` to `GZIP` to reduce the size of the report file and increase download speed.
109
156
  #
110
- # The currently supported reports are: **Document Line**, **Document Line Detail**, **Multitax Line Detail**, **Liability**, **Tax Region**, **AP Document**, **AP Document Detail**, and **Document Line Detail All Taxes**.
157
+ # The currently supported reports are: **Document**, **Document Summary**, **Document Line**, **Document Line Detail**, **Multitax Line Detail**, **Liability**, **Tax Region**, **AP Document**, **AP Document Detail**, and **Document Line Detail All Taxes**.
111
158
  #
112
159
  # ### Security Policies
113
160
  #
@@ -133,6 +180,13 @@ module AvaTax
133
180
  #
134
181
  # This API call returns information about all report types across your entire account.
135
182
  #
183
+ # Audit-log report types (`audit`, `audittransactionlogs`) are not included in this list; retrieve those via the
184
+ # `GetAuditLogReport` / `DownloadAuditLogReport` APIs.
185
+ #
186
+ # Pagination note: when the response includes a non-null `pageKey` (next link), more results may exist and the
187
+ # caller should follow it, even if the current page returned fewer than the requested number of records. This can
188
+ # happen when a `$filter` is applied, because matches are evaluated server-side across backend pages.
189
+ #
136
190
  # ### Security Policies
137
191
  #
138
192
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
@@ -141,6 +195,7 @@ module AvaTax
141
195
  # @param pageKey [String] Provide a page key to retrieve the next page of results.
142
196
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
143
197
  # @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.
198
+ # @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:* reportType, parameters, status, size, format, file, createdUser, completedDate
144
199
  # @return [FetchResult]
145
200
  def list_reports(options={}) path = "/api/v2/reports"
146
201
  get(path, options, AvaTax::VERSION) end
@@ -37,7 +37,7 @@ module AvaTax
37
37
  # Swagger Name: AvaTaxClient
38
38
  # @param companyId [Integer] The ID number of the company to search
39
39
  # @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 vendors linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
40
- # @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:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages
40
+ # @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:* documentTypeId, documentTypeDescription, exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
41
41
  # @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.
42
42
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
43
43
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -121,7 +121,7 @@ module AvaTax
121
121
  # @param companyId [Integer] The unique ID number of the company that recorded this vendor
122
122
  # @param vendorCode [String] The unique code representing this vendor
123
123
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * vendors - Retrieves the list of vendors linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
124
- # @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:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages
124
+ # @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:* documentTypeId, documentTypeDescription, exemptionNumber, jurisdictions, ecmsId, ecmsStatus, pdf, pages
125
125
  # @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.
126
126
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
127
127
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '26.6.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '26.7.3'.freeze unless defined?(::AvaTax::VERSION)
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: avatax
3
3
  version: !ruby/object:Gem::Version
4
- version: 26.6.0
4
+ version: 26.7.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marcus Vorwaller
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-06-09 00:00:00.000000000 Z
11
+ date: 2026-07-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -153,6 +153,7 @@ files:
153
153
  - lib/avatax/client/glaccount.rb
154
154
  - lib/avatax/client/items.rb
155
155
  - lib/avatax/client/itemsreversesync.rb
156
+ - lib/avatax/client/jobs.rb
156
157
  - lib/avatax/client/jurisdictionoverrides.rb
157
158
  - lib/avatax/client/locations.rb
158
159
  - lib/avatax/client/multidocument.rb