avatax 25.9.0 → 25.11.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: 23f96fe04e44a337b97d4cae6ecadfb1d3794a0b13e71c30df8e9cc0d4a619de
4
- data.tar.gz: e1602324a3afa4765c69d10a80d0b0c408a7a84ee5cb68a46f099d2103358059
3
+ metadata.gz: 3599e81d1f6248e309d3295fe6a6f820ed0016314b417bead857642958806b5f
4
+ data.tar.gz: a10405f81dda7089560a772558294ff8ea15d4818a9d11597db115a227b50d0c
5
5
  SHA512:
6
- metadata.gz: 620c96169d9ad422a0268981770df51ac67502efdfa3a069d76287a3b5f8df6eb907e7fe6b20d544e8d01e5e1f5bf4cd4976413bdbba4f9271d5a2b2382a8c9b
7
- data.tar.gz: 0dfba7fae41785348919a80a603bcace86538589e192cd662d53fb3a1505e930a8ec04c9e6fe21d4129d686a032c10ba027427a7384d85234fbeba0c72c8d477
6
+ metadata.gz: 3c24eccb032c772ec228c1d70c180823d7f6454acf6326d3904e44859aaeaceae0c24005f4679a9f961de3237862bd2aad649899f18f2df348adb4526d5eb6cb
7
+ data.tar.gz: 2ead5356caed15d42e07b56f84a1c9d30e43eb3f140d3e00ea08ad9adad741ef1cd80da60ed056663f752a923b796e3dfd83ca2dba56359a26edc1ac2698b4f3
@@ -82,7 +82,7 @@ module AvaTax
82
82
  #
83
83
  # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
84
84
  # Swagger Name: AvaTaxClient
85
- # @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:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId
85
+ # @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:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId, isCustomContent
86
86
  # @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.
87
87
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
88
88
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -388,6 +388,7 @@ module AvaTax
388
388
  # @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.
389
389
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
390
390
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
391
+ # @param includeCustomContent [Boolean] Optional query parameter to include custom content jurisdictions (default: false)
391
392
  # @return [FetchResult]
392
393
  def list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
393
394
  get(path, options, AvaTax::VERSION) end
@@ -416,6 +417,7 @@ module AvaTax
416
417
  # @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
417
418
  # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
418
419
  # @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
420
+ # @param includeCustomContent [Boolean] Optional query parameter to include custom content jurisdiction types (default: false)
419
421
  # @return [string[]]
420
422
  def list_jurisdiction_types_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictionTypes/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
421
423
  get(path, options, AvaTax::VERSION) end
@@ -891,6 +893,7 @@ module AvaTax
891
893
  # @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.
892
894
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
893
895
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
896
+ # @param includeCustomContent [Boolean] Optional query parameter to include custom content rate types (default: false)
894
897
  # @return [FetchResult]
895
898
  def list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/ratetypes"
896
899
  get(path, options, AvaTax::VERSION) end
@@ -939,6 +942,7 @@ module AvaTax
939
942
  # @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.
940
943
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
941
944
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
945
+ # @param includeCustomContent [Boolean] Optional query parameter to include custom content regions (default: false)
942
946
  # @return [FetchResult]
943
947
  def list_regions_by_country_and_tax_type_and_tax_sub_type_and_rate_type(companyId, country, taxTypeId, taxSubTypeId, rateTypeId, jurisdictionTypeId, options={}) path = "/api/v2/definitions/companies/#{companyId}/countries/#{country}/regions/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/rateTypeId/#{rateTypeId}/jurisdictionTypeId/#{jurisdictionTypeId}"
944
948
  get(path, options, AvaTax::VERSION) end
@@ -978,7 +982,7 @@ module AvaTax
978
982
  # You may always contact Avalara's sales department for information on available products or services.
979
983
  # You cannot change your subscriptions directly through the API.
980
984
  # Swagger Name: AvaTaxClient
981
- # @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:* taxTypeGroupIdSK
985
+ # @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:* system, taxTypeGroupIdSK
982
986
  # @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.
983
987
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
984
988
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -1109,6 +1113,7 @@ module AvaTax
1109
1113
  # @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.
1110
1114
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
1111
1115
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1116
+ # @param includeCustomContent [Boolean] Optional query parameter to include custom content tax sub types (default: false)
1112
1117
  # @return [FetchResult]
1113
1118
  def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
1114
1119
  get(path, options, AvaTax::VERSION) end
@@ -1150,6 +1155,7 @@ module AvaTax
1150
1155
  # @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.
1151
1156
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
1152
1157
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1158
+ # @param includeCustomContent [Boolean] Optional query parameter to include custom content tax types (default: false)
1153
1159
  # @return [FetchResult]
1154
1160
  def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
1155
1161
  get(path, options, AvaTax::VERSION) end
@@ -45,6 +45,10 @@ module AvaTax
45
45
  #
46
46
  # Create/Update one or more item objects attached to this company.
47
47
  #
48
+ # Recommended number of items to create/update in a single call is upto 100.
49
+ #
50
+ # Currently, the maximum number of items that can be created/updated in a single call is 500 (This limit is subject to change).
51
+ #
48
52
  # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
49
53
  # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
50
54
  # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
@@ -113,6 +117,10 @@ module AvaTax
113
117
  #
114
118
  # Creates one or more new item objects attached to this company.
115
119
  #
120
+ # Recommended number of items to create in a single call is upto 50.
121
+ #
122
+ # Currently, the maximum number of items that can be created in a single call is 500 (This limit is subject to change).
123
+ #
116
124
  # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
117
125
  # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
118
126
  # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
@@ -786,6 +794,10 @@ module AvaTax
786
794
  #
787
795
  # Creates/updates one or more item objects with additional properties and the AvaTax category attached to this company.
788
796
  #
797
+ # Recommended number of items to create/update in a single call is upto 100.
798
+ #
799
+ # Currently, the maximum number of items that can be created/updated in a single call is 1000 (This limit is subject to change).
800
+ #
789
801
  # Items are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to create
790
802
  # a new or update an existing item. This can be used to sync the items with Avalara. For example, an accounting software
791
803
  # system can use this to sync all their items from an ERP with Avalara.
@@ -809,7 +821,7 @@ module AvaTax
809
821
  #
810
822
  # Any invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information.
811
823
  #
812
- # This API is currently limited to 1000 items per call (the limit is subject to change).
824
+ # This API is currently limited to 500 items per call (the limit is subject to change).
813
825
  #
814
826
  # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
815
827
  # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
@@ -135,7 +135,7 @@ module AvaTax
135
135
  #
136
136
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
137
137
  # Swagger Name: AvaTaxClient
138
- # @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:* taxTypeGroupIdSK
138
+ # @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:* system, taxTypeGroupIdSK
139
139
  # @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.
140
140
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
141
141
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
@@ -0,0 +1,49 @@
1
+ module AvaTax
2
+ class Client
3
+ module VendorCertificates
4
+
5
+
6
+ # List all vendor certificates for a company
7
+ #
8
+ # List all certificates recorded by a company
9
+ #
10
+ # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
11
+ # can contain information about a vendor's eligibility for exemption from sales or use taxes based on
12
+ # criteria you specify when you store the certificate. To view or manage your certificates directly, please
13
+ # log onto the administrative website for the product you purchased.
14
+ #
15
+ # You can use the `$include` parameter to fetch the following additional objects for expansion:
16
+ #
17
+ # * customers - Retrieves the list of vendors linked to the certificate.
18
+ # * po_numbers - Retrieves all PO numbers tied to the certificate.
19
+ # * attributes - Retrieves all attributes applied to the certificate.
20
+ # * histories - Retrieves the certificate update history
21
+ # * jobs - Retrieves the jobs for this certificate
22
+ # * logs - Retrieves the certificate log
23
+ # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
24
+ # * custom_fields - Retrieves custom fields set for this certificate
25
+ #
26
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
27
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
28
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
29
+ # certificate storage for this company, call `RequestCertificateSetup`.
30
+ #
31
+ # Note* Filtering not supported for any documentType field.
32
+ #
33
+ # ### Security Policies
34
+ #
35
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
36
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
37
+ # Swagger Name: AvaTaxClient
38
+ # @param companyId [Integer] The ID number of the company to search
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
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
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
43
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
44
+ # @return [FetchResult]
45
+ def query_vendor_certificates(companyId, options={}) path = "/#{companyId}/vendor-certificates"
46
+ get(path, options, AvaTax::VERSION) end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,126 @@
1
+ module AvaTax
2
+ class Client
3
+ module Vendors
4
+
5
+
6
+ # Retrieve a single vendor
7
+ #
8
+ # Retrieve the vendor identified by this URL.
9
+ #
10
+ # A vendor object defines information about a person or business that purchases products from your
11
+ # company. When you create a tax transaction in AvaTax, you can use the `customerCode` from this
12
+ # record in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and
13
+ # identify any certificates linked to this vendor object. If any certificate applies to the transaction,
14
+ # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
15
+ #
16
+ # You can use the `$include` parameter to fetch the following additional objects for expansion:
17
+ #
18
+ # * certificates - Fetch a list of certificates linked to this vendor.
19
+ # * attributes - Retrieves all attributes applied to the vendor.
20
+ # * active_certificates - Retrieves all the active certificates linked to this vendor
21
+ # * histories - Retrieves the update history for this vendor
22
+ # * logs - Retrieves vendor logs
23
+ # * jobs - Retrieves vendor jobs
24
+ # * billTos - Retrieves bill-tos linked with this vendor
25
+ # * shipTos - Retrieves ship-tos linked with this vendor
26
+ # * shipToStates - Retrieves ship-to states for this vendor
27
+ # * custom_fields - Retrieves custom fields set for this vendor
28
+ #
29
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
30
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
31
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
32
+ # certificate storage for this company, call `RequestCertificateSetup`.
33
+ #
34
+ # ### Security Policies
35
+ #
36
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
37
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
38
+ # Swagger Name: AvaTaxClient
39
+ # @param companyId [Integer] The unique ID number of the company that recorded this vendor
40
+ # @param vendorCode [String]
41
+ # @param include [String] Specify optional additional objects to include in this fetch request
42
+ # @return [Object]
43
+ def get_vendor(companyId, vendorCode, options={}) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}"
44
+ get(path, options, AvaTax::VERSION) end
45
+
46
+ # List certificates linked to a vendor
47
+ #
48
+ # List all certificates linked to a vendor.
49
+ #
50
+ # A vendor object defines information about a person or business that purchases products from your
51
+ # company. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this
52
+ # record in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and
53
+ # identify any certificates linked to this `vendor` object. If any certificate applies to the transaction,
54
+ # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
55
+ #
56
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
57
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
58
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
59
+ # certificate storage for this company, call `RequestCertificateSetup`.
60
+ #
61
+ # You can filter certificates by exposure zone name using the $filter parameter with the syntax:
62
+ # `$filter=exposureZoneName eq 'ZoneName'` or `$filter=contains(exposureZoneName,'PartialName')`
63
+ #
64
+ # ### Security Policies
65
+ #
66
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
67
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
68
+ # Swagger Name: AvaTaxClient
69
+ # @param companyId [Integer] The unique ID number of the company that recorded this vendor
70
+ # @param vendorCode [String] The unique code representing this vendor
71
+ # @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
72
+ # @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
73
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
74
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
75
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
76
+ # @return [FetchResult]
77
+ def list_certificates_for_vendor(companyId, vendorCode, options={}) path = "/api/v2/companies/#{companyId}/vendors/#{vendorCode}/certificates"
78
+ get(path, options, AvaTax::VERSION) end
79
+
80
+ # List all vendors for this company
81
+ #
82
+ # List all vendors recorded by this company matching the specified criteria.
83
+ #
84
+ # A vendor object defines information about a person or business that purchases products from your
85
+ # company. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this
86
+ # record in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and
87
+ # identify any certificates linked to this `vendor` object. If any certificate applies to the transaction,
88
+ # AvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.
89
+ #
90
+ # You can use the `$include` parameter to fetch the following additional objects for expansion:
91
+ #
92
+ # * certificates - Fetch a list of certificates linked to this vendor.
93
+ # * attributes - Retrieves all attributes applied to the vendor.
94
+ # * active_certificates - Retrieves all the active certificates linked to this vendor
95
+ # * histories - Retrieves the update history for this vendor
96
+ # * logs - Retrieves vendor logs
97
+ # * jobs - Retrieves vendor jobs
98
+ # * billTos - Retrieves bill-tos linked with this vendor
99
+ # * shipTos - Retrieves ship-tos linked with this vendor
100
+ # * shipToStates - Retrieves ship-to states for this vendor
101
+ # * custom_fields - Retrieves custom fields set for this vendor
102
+ #
103
+ # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
104
+ # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
105
+ # certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
106
+ # certificate storage for this company, call `RequestCertificateSetup`.
107
+ #
108
+ # Note* Filtering not supported for isVendor field.
109
+ #
110
+ # ### Security Policies
111
+ #
112
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
113
+ # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
114
+ # Swagger Name: AvaTaxClient
115
+ # @param companyId [Integer] The unique ID number of the company that recorded this vendor
116
+ # @param include [String] OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.
117
+ # @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/).
118
+ # @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.
119
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
120
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
121
+ # @return [FetchResult]
122
+ def query_vendors(companyId, options={}) path = "/api/v2/companies/#{companyId}/vendors"
123
+ get(path, options, AvaTax::VERSION) end
124
+ end
125
+ end
126
+ end
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '25.9.0'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '25.11.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: 25.9.0
4
+ version: 25.11.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: 2025-09-11 00:00:00.000000000 Z
11
+ date: 2025-11-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -176,6 +176,8 @@ files:
176
176
  - lib/avatax/client/userdefinedfields.rb
177
177
  - lib/avatax/client/users.rb
178
178
  - lib/avatax/client/utilities.rb
179
+ - lib/avatax/client/vendorcertificates.rb
180
+ - lib/avatax/client/vendors.rb
179
181
  - lib/avatax/configuration.rb
180
182
  - lib/avatax/connection.rb
181
183
  - lib/avatax/request.rb