avatax 26.5.0 → 26.6.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5dc32c4d50d3f06a0e19a6f0221ab7c0b0dae4c5fc6cef906f8132cc5ba35bb4
4
- data.tar.gz: 8a88a83d37197697af220ef1c0d4c9419c11556ebb89cb54eb619327d20ec7f2
3
+ metadata.gz: bb79a9f4603321ed83713aa67ec0e32e37f649d8a13eb5d7a57f5b97c001c55f
4
+ data.tar.gz: fe20a61f2dfcef13b8fe611c40778b3d31933dcbfc7128fb6c4c9ad42b155f72
5
5
  SHA512:
6
- metadata.gz: fbf907dd44b45fcb9945b85d1fe2b75005abbfa74b214c68293497d521a753a8d4b14460d1315341637cd1c4203b4e91836955de7e95a300e7a6fb2d4be2dec5
7
- data.tar.gz: 197d2602ecd59c91885c1342a845c11631f79a89b2a92c44137f090c676a4ece7f9f4506e5fe7f7f25a1322de3fdca446f5bbf25e9c9f89cde5160fb451dbf82
6
+ metadata.gz: 2bbc3af857171c4380fd509e5e95f66a8a6c6cc4b0d23757e7dca79e29e48fcb56a72b969918341a987fa59599fc28d399b2163cbc50ede94862bf639fefa7be
7
+ data.tar.gz: d1c3d9e022a9a6c9aaf5c32a7762633b868a9157537f5b7b546831d3aef59813c2ed0c00ee8fdac824ad350b1c2c0190e533c38317bb29df4f36646ded7093e0
@@ -136,6 +136,7 @@ module AvaTax
136
136
  # * logs - Retrieves the certificate log
137
137
  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
138
138
  # * custom_fields - Retrieves custom fields set for this certificate
139
+ # * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
139
140
  #
140
141
  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
141
142
  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -149,7 +150,7 @@ module AvaTax
149
150
  # Swagger Name: AvaTaxClient
150
151
  # @param companyId [Integer] The ID number of the company that recorded this certificate
151
152
  # @param id [Integer] The unique ID number of this certificate
152
- # @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
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
153
154
  # @return [Object]
154
155
  def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
155
156
  get(path, options, AvaTax::VERSION) end
@@ -309,6 +310,35 @@ module AvaTax
309
310
  def list_custom_fields_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/custom-fields"
310
311
  get(path, {}, AvaTax::VERSION) end
311
312
 
313
+ # List local exempt jurisdictions for a given exposure zone and tax code
314
+ #
315
+ # Returns the list of jurisdictions that are valid for a given combination of exposure zone
316
+ # and exemption tax code. The returned jurisdictions can be used to add valid jurisdictions
317
+ # to a certificate.
318
+ #
319
+ # Both `exposureZone` and `taxCode` are mandatory query parameters.
320
+ #
321
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
322
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
323
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
324
+ # certificate storage for this company, call `RequestCertificateSetup`.
325
+ #
326
+ # ### Security Policies
327
+ #
328
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
329
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
330
+ # Swagger Name: AvaTaxClient
331
+ # @param companyId [Integer] The ID number of the company
332
+ # @param exposureZone [String] Required. The exposure zone name used to filter valid jurisdictions (e.g., "California").
333
+ # @param taxCode [String] Required. The exemption tax code used to filter valid jurisdictions (e.g., "RESALE").
334
+ # @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:* region, country, customerUsageType
335
+ # @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.
336
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
337
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
338
+ # @return [FetchResult]
339
+ def list_local_exempt_jurisdictions(companyId, options={}) path = "/api/v2/companies/#{companyId}/jurisdictions"
340
+ get(path, options, AvaTax::VERSION) end
341
+
312
342
  # List all certificates for a company
313
343
  #
314
344
  # List all certificates recorded by a company
@@ -328,6 +358,7 @@ module AvaTax
328
358
  # * logs - Retrieves the certificate log
329
359
  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
330
360
  # * custom_fields - Retrieves custom fields set for this certificate
361
+ # * jurisdictions - Retrieves the list of jurisdictions associated with the certificate
331
362
  #
332
363
  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
333
364
  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -340,7 +371,7 @@ module AvaTax
340
371
  # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
341
372
  # Swagger Name: AvaTaxClient
342
373
  # @param companyId [Integer] The ID number of the company to search
343
- # @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
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
344
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
345
376
  # @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.
346
377
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -471,6 +471,10 @@ module AvaTax
471
471
  # * `vatNumberStatus` - Filter by VAT number validation status (0=NotValidated, 1=Valid, 2=Invalid, 3=Error)
472
472
  # * `businessNameStatus` - Filter by business name comparison status (0=NotValidated, 1=Valid, 2=Invalid, 3=Error)
473
473
  # * `businessName` - Filter by business name
474
+ # * `validationSource` - Filter by validation source ('VIES' or 'ELR')
475
+ # * `validationDate` - Filter by last validation timestamp (e.g., `validationDate gt 2026-01-01`)
476
+ # * `createdDate` - Filter by record creation timestamp (e.g., `createdDate ge 2026-01-01`)
477
+ # * `modifiedDate` - Filter by record modification timestamp (e.g., `modifiedDate gt 2026-05-01T00:00:00Z`)
474
478
  #
475
479
  # Order results using `$orderBy`. Common orderings:
476
480
  # * `vatNumber ASC` - Order by VAT number ascending
@@ -482,7 +486,7 @@ module AvaTax
482
486
  # * 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, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
483
487
  # Swagger Name: AvaTaxClient
484
488
  # @param companyId [Integer] The ID of the company
485
- # @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:* createdDate, modifiedDate
489
+ # @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/).
486
490
  # @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.
487
491
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
488
492
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -275,7 +275,7 @@ module AvaTax
275
275
  # Swagger Name: AvaTaxClient
276
276
  # @param companyId [Integer] The unique ID number of the company that recorded this customer
277
277
  # @param customerCode [String] The unique code representing this customer
278
- # @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
278
+ # @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
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
280
280
  # @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
281
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -309,6 +309,16 @@ module AvaTax
309
309
  def list_item_h_s_code_classification_status() path = "/api/v2/definitions/items/hscode-classification-status"
310
310
  get(path, {}, AvaTax::VERSION) end
311
311
 
312
+ # List of all event types that can be subscribed to for Item reverse sync webhook registrations.
313
+ #
314
+ # ### Security Policies
315
+ #
316
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
317
+ # Swagger Name: AvaTaxClient
318
+ # @return [ItemReverseSyncEventDefinitionOutputModel[]]
319
+ def list_item_reverse_sync_events() path = "/api/v2/definitions/items/events"
320
+ get(path, {}, AvaTax::VERSION) end
321
+
312
322
  # List of all recommendation status which can be assigned to an item
313
323
  #
314
324
  # ### Security Policies
@@ -342,6 +352,7 @@ module AvaTax
342
352
  # @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.
343
353
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
344
354
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
355
+ # @param companyId [Integer] Optional query parameter; when set, the result set is restricted to jurisdictions in regions where the company has nexus. When omitted, all jurisdiction rows are eligible before filter is applied.
345
356
  # @return [FetchResult]
346
357
  def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
347
358
  get(path, options, AvaTax::VERSION) end
@@ -412,6 +423,33 @@ module AvaTax
412
423
  def list_jurisdictions_hierarchy(options={}) path = "/api/v2/definitions/jurisdictions/hierarchy"
413
424
  get(path, options, AvaTax::VERSION) end
414
425
 
426
+ # List tax types, subtypes, and rate types applicable for a given jurisdiction
427
+ #
428
+ # Returns a list of tax type and subtype groups, and optionally the available rate types for each group, applicable for a given jurisdiction.
429
+ #
430
+ # This API lets you filter tax types and rate types based on whether they may apply in a given jurisdiction and provides a description of each.
431
+ #
432
+ # If a company ID is provided, then only the tax types for which the company has nexus are shown.
433
+ #
434
+ # If custom content is included, then all available custom tax types are included in the result if the calling user has the appropriate subscription
435
+ # and the tax types are available in the jurisdiction's country.
436
+ # Swagger Name: AvaTaxClient
437
+ # @param country [String] ISO country code (e.g. `US`)
438
+ # @param region [String] ISO region or state/province code (e.g. `CA` for California)
439
+ # @param jurisdictionTypeId [String] Jurisdiction type identifier (e.g. `STA` for state)
440
+ # @param jurisdictionCode [String] Code identifying a specific jurisdiction
441
+ # @param companyId [Integer] Optional query parameter. When set, tax type/subtype pairs are filtered to those which correspond to the company's configured nexus. When omitted, no nexus-based filtering is applied.
442
+ # @param effectiveDate [DateTime] Optional query parameter. When companyId is not provided, this is the date used to filter effective tax types and rate types. Defaults to the current date.
443
+ # @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.
444
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
445
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
446
+ # @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:* rateTypes
447
+ # @param includeCustomContent [Boolean] When true, merges in potentially applicable custom tax types and subtypes into result (i.e. for which no system content is defined). Defaults to false.
448
+ # @param includeRateTypes [Boolean] Query parameter `$includeRateTypes`. When true (default), returns the rate types available for each tax type + subtype pair in the result.
449
+ # @return [FetchResult]
450
+ def list_jurisdiction_tax_types_and_sub_types(country, region, jurisdictionTypeId, jurisdictionCode, options={}) path = "/api/v2/definitions/jurisdictions/#{country}/#{region}/#{jurisdictionTypeId}/#{jurisdictionCode}/taxTypesAndSubTypes"
451
+ get(path, options, AvaTax::VERSION) end
452
+
415
453
  # List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
416
454
  #
417
455
  # Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId
@@ -1289,6 +1289,18 @@ module AvaTax
1289
1289
  # @return [ItemParameterModel[]]
1290
1290
  def upsert_item_parameter(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
1291
1291
  put(path, model, {}, AvaTax::VERSION) end
1292
+
1293
+ # Verify the HSCode to be valid/invalid
1294
+ #
1295
+ # ### Security Policies
1296
+ #
1297
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
1298
+ # Swagger Name: AvaTaxClient
1299
+ # @param companyId [Integer] The unique ID of the company
1300
+ # @param model [ItemHSCodeVerificationInputModel[]] The request model for HS Code Verification
1301
+ # @return [Object]
1302
+ def verify_h_s_code(companyId, model) path = "/api/v2/companies/#{companyId}/items/hscodes/$verify"
1303
+ post(path, model, {}, AvaTax::VERSION) end
1292
1304
  end
1293
1305
  end
1294
1306
  end
@@ -0,0 +1,82 @@
1
+ module AvaTax
2
+ class Client
3
+ module ItemsReverseSync
4
+
5
+
6
+ # Create a webhook registration for a company.
7
+ #
8
+ # Creates a webhook registration for the specified company. The registration defines a
9
+ # connector, callback URL, registration type, and subscribed events.
10
+ #
11
+ # The customer must pass the connector name in `connectorName`; this value is also
12
+ # used as the OAuth scope for the registration.
13
+ #
14
+ # ### Security Policies
15
+ #
16
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
17
+ # Swagger Name: AvaTaxClient
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.
20
+ # @return [Object]
21
+ def create_reverse_sync_registration(companyId, model) path = "/api/v2/connector-sync/companies/#{companyId}/registrations"
22
+ post(path, model, {}, AvaTax::VERSION) end
23
+
24
+ # Delete a webhook registration.
25
+ #
26
+ # Deletes the webhook registration identified by the specified registration ID for the given company.
27
+ #
28
+ # ### Security Policies
29
+ #
30
+ # * This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
31
+ # Swagger Name: AvaTaxClient
32
+ # @param companyId [Integer] The ID of the company that owns this registration.
33
+ # @param registrationId [Integer] The ID of the registration to delete.
34
+ # @return [ObjectDeletedErrorModel[]]
35
+ def delete_reverse_sync_registration(companyId, registrationId) path = "/api/v2/connector-sync/companies/#{companyId}/registrations/#{registrationId}"
36
+ delete(path, {}, AvaTax::VERSION) end
37
+
38
+ # Retrieve a webhook registration.
39
+ #
40
+ # Returns the webhook registration identified by the specified registration ID for the given company.
41
+ #
42
+ # ### Security Policies
43
+ #
44
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
45
+ # Swagger Name: AvaTaxClient
46
+ # @param companyId [Integer] The ID of the company that owns this registration.
47
+ # @param registrationId [Integer] The ID of the registration.
48
+ # @return [Object]
49
+ def get_reverse_sync_registration(companyId, registrationId) path = "/api/v2/connector-sync/companies/#{companyId}/registrations/#{registrationId}"
50
+ get(path, {}, AvaTax::VERSION) end
51
+
52
+ # List webhook registrations for a company.
53
+ #
54
+ # Returns all webhook registrations for the specified company.
55
+ #
56
+ # ### Security Policies
57
+ #
58
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
59
+ # Swagger Name: AvaTaxClient
60
+ # @param companyId [Integer] The ID of the company that owns the webhook registrations.
61
+ # @return [FetchResult]
62
+ def list_reverse_sync_registrations(companyId) path = "/api/v2/connector-sync/companies/#{companyId}/registrations"
63
+ get(path, {}, AvaTax::VERSION) end
64
+
65
+ # Update a webhook registration.
66
+ #
67
+ # Updates the webhook registration with the provided fields. Only the fields included in the
68
+ # request body are updated.
69
+ #
70
+ # ### Security Policies
71
+ #
72
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
73
+ # Swagger Name: AvaTaxClient
74
+ # @param companyId [Integer] The ID of the company that owns this registration.
75
+ # @param registrationId [Integer] The ID of the registration to update.
76
+ # @param model [Object] The registration fields to update.
77
+ # @return [Object]
78
+ def update_reverse_sync_registration(companyId, registrationId, model) path = "/api/v2/connector-sync/companies/#{companyId}/registrations/#{registrationId}"
79
+ patch(path, model, {}, AvaTax::VERSION) end
80
+ end
81
+ end
82
+ end
@@ -32,6 +32,29 @@ module AvaTax
32
32
  def create_vendors(companyId, model) path = "/api/v2/companies/#{companyId}/vendors"
33
33
  post(path, model, {}, AvaTax::VERSION) end
34
34
 
35
+ # Delete a vendor record
36
+ #
37
+ # Deletes the vendor object referenced by this URL.
38
+ #
39
+ # A vendor object defines information about a person or business that you purchase products from.
40
+ # The same CertCapture customer resource is used for vendors (isVendor flag). Deleting removes the record.
41
+ #
42
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
43
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
44
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
45
+ # certificate storage for this company, call `RequestCertificateSetup`.
46
+ #
47
+ # ### Security Policies
48
+ #
49
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
50
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
51
+ # Swagger Name: AvaTaxClient
52
+ # @param companyId [Integer] The unique ID number of the company that recorded this vendor
53
+ # @param vendorCode [String] The unique code representing this vendor
54
+ # @return []
55
+ def delete_vendor(companyId, vendorCode) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}"
56
+ delete(path, {}, AvaTax::VERSION) end
57
+
35
58
  # Retrieve a single vendor
36
59
  #
37
60
  # Retrieve the vendor identified by this URL.
@@ -54,7 +77,7 @@ module AvaTax
54
77
  # * shipTos - Retrieves ship-tos linked with this vendor
55
78
  # * shipToStates - Retrieves ship-to states for this vendor
56
79
  # * custom_fields - Retrieves custom fields set for this vendor
57
- #
80
+ # * vendorAdditionalInfo - Retrieves vendorAdditionalInfo for this vendor
58
81
  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
59
82
  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
60
83
  # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
@@ -128,6 +151,7 @@ module AvaTax
128
151
  # * shipTos - Retrieves ship-tos linked with this vendor
129
152
  # * shipToStates - Retrieves ship-to states for this vendor
130
153
  # * custom_fields - Retrieves custom fields set for this vendor
154
+ # * vendorAdditionalInfo - Retrieves vendorAdditionalInfo for vendors
131
155
  #
132
156
  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
133
157
  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -150,6 +174,32 @@ module AvaTax
150
174
  # @return [FetchResult]
151
175
  def query_vendors(companyId, options={}) path = "/api/v2/companies/#{companyId}/vendors"
152
176
  get(path, options, AvaTax::VERSION) end
177
+
178
+ # Update a single vendor
179
+ #
180
+ # Replace the vendor object with a new record.
181
+ #
182
+ # A vendor object defines information about a person or business that you purchase products from.
183
+ # When you create a tax transaction in AvaTax, you can use the `vendorCode` from this
184
+ # record. AvaTax will search for this `vendorCode` value and identify any certificates
185
+ # linked to this vendor object.
186
+ #
187
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
188
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
189
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
190
+ # certificate storage for this company, call `RequestCertificateSetup`.
191
+ #
192
+ # ### Security Policies
193
+ #
194
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
195
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
196
+ # Swagger Name: AvaTaxClient
197
+ # @param companyId [Integer] The unique ID number of the company that recorded this vendor
198
+ # @param vendorCode [String] The unique code representing this vendor
199
+ # @param model [Object] The new vendor model that will replace the existing record at this URL
200
+ # @return [Object]
201
+ def update_vendor(companyId, vendorCode, model) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}"
202
+ put(path, model, {}, AvaTax::VERSION) end
153
203
  end
154
204
  end
155
205
  end
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '26.5.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '26.6.0'.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.5.0
4
+ version: 26.6.0
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-05-22 00:00:00.000000000 Z
11
+ date: 2026-06-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -152,6 +152,7 @@ files:
152
152
  - lib/avatax/client/fundingrequests.rb
153
153
  - lib/avatax/client/glaccount.rb
154
154
  - lib/avatax/client/items.rb
155
+ - lib/avatax/client/itemsreversesync.rb
155
156
  - lib/avatax/client/jurisdictionoverrides.rb
156
157
  - lib/avatax/client/locations.rb
157
158
  - lib/avatax/client/multidocument.rb