From b45463ecb166c92cfe1570023982d919c69e2c8e Mon Sep 17 00:00:00 2001 From: svc-developer Date: Mon, 12 Feb 2024 17:57:05 +0000 Subject: [PATCH] 24.2.0 --- src/Constants.php | 41 ++++++- src/Methods.php | 281 ++++++++++++++++++++++++++++++-------------- src/Models.php | 293 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 524 insertions(+), 91 deletions(-) diff --git a/src/Constants.php b/src/Constants.php index 6156b35..6dbacd0 100644 --- a/src/Constants.php +++ b/src/Constants.php @@ -2,7 +2,7 @@ namespace Avalara; use GuzzleHttp\Client; -define('AVATAX_SDK_VERSION', '23.11.0'); +define('AVATAX_SDK_VERSION', '24.2.0'); /***************************************************************************** * * @@ -328,6 +328,35 @@ class POASubscriptionType } +/** + * Swagger Name: AvaTaxClient + * Defines how a stack rate is determined for a specific country and region. + */ +class StackAggregationOption +{ + /** + * No aggregation. + * The component rate is used for the stack rate. + */ + const C_NOSTACKAGGREGATION = 0; + + /** + * Rates are aggregated across all jurisdiction types. + */ + const C_FULLSTACKAGGREGATION = 1; + + /** + * State and county rates are aggregated. + */ + const C_AGGREGATESTATEANDCOUNTY = 2; + + /** + * City and county rates are aggregated. + */ + const C_AGGREGATECITYANDCOUNTY = 3; + +} + /** * Swagger Name: AvaTaxClient * Status of an Avalara account @@ -1766,6 +1795,11 @@ class ErrorCodeId const C_CONTENTNOTFOUND = 2811; const C_REGISTRATIONNUMBERNOTFOUND = 2812; const C_INVALIDCOSTCENTER = 2813; + + /** + * Occurs when a Header value is incorrect or invalid in some way + */ + const C_INVALIDHTTPHEADER = 3000; } @@ -1955,6 +1989,11 @@ class DocumentStatus */ const C_PENDINGAPPROVAL = 7; + /** + * This new status is added for Reporting API to download get reports with Saved(1) and Posted(2) state. + */ + const C_UNCOMMITTED = 12; + /** * DEPRECATED - Represents "a document in any status" when searching. Please search using the * [Filtering in REST](/avatax/filtering-in-rest/) documentation. diff --git a/src/Methods.php b/src/Methods.php index 98cd0fb..636f196 100644 --- a/src/Methods.php +++ b/src/Methods.php @@ -1078,7 +1078,7 @@ public function queryBatches($filter=null, $include=null, $top=null, $skip=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that will record certificates @@ -1117,7 +1117,7 @@ public function createCertExpressInvitation($companyId, $customerCode, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that issued this invitation @@ -1157,7 +1157,7 @@ public function getCertExpressInvitation($companyId, $customerCode, $id, $includ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that issued this invitation @@ -1196,8 +1196,8 @@ public function listCertExpressInvitations($companyId, $include=null, $filter=nu * * Your tax transaction must contain the correct customer code * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * If the users specified in the certificates do not exist, the API will create the user and link them to the certificate @@ -1205,7 +1205,7 @@ public function listCertExpressInvitations($companyId, $include=null, $filter=nu * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company recording this certificate @@ -1235,14 +1235,14 @@ public function createCertificates($companyId, $preValidatedExemptionReason, $mo * Revoked certificates can no longer be used. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1272,14 +1272,14 @@ public function deleteCertificate($companyId, $id) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1314,14 +1314,14 @@ public function downloadCertificateImage($companyId, $id, $page, $type) { * * attributes - Retrieves all attributes applied to the certificate. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company that recorded this certificate @@ -1352,7 +1352,7 @@ public function getCertificate($companyId, $id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The company ID to check @@ -1381,14 +1381,14 @@ public function getCertificateSetup($companyId) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1420,14 +1420,14 @@ public function linkAttributesToCertificate($companyId, $id, $model) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1458,14 +1458,14 @@ public function linkCustomersToCertificate($companyId, $id, $model) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1495,14 +1495,14 @@ public function listAttributesForCertificate($companyId, $id) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1536,14 +1536,14 @@ public function listCustomersForCertificate($companyId, $id, $include=null) { * * attributes - Retrieves all attributes applied to the certificate. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company to search @@ -1579,7 +1579,7 @@ public function queryCertificates($companyId, $include=null, $filter=null, $top= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId @@ -1608,14 +1608,14 @@ public function requestCertificateSetup($companyId) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1648,14 +1648,14 @@ public function unlinkAttributesFromCertificate($companyId, $id, $model) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -1683,14 +1683,14 @@ public function unlinkCustomersFromCertificate($companyId, $id, $model) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company that recorded this certificate @@ -1721,14 +1721,14 @@ public function updateCertificate($companyId, $id, $model) { * log onto the administrative website for the product you purchased. * * Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. - * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption - * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption + * Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption + * certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption * certificate storage for this company, call `RequestCertificateSetup`. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate @@ -2437,6 +2437,138 @@ public function updateCompanyParameterDetail($companyId, $id, $model) { return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); } + /** + * Retrieve all unique jurisnames based on filter. + * + * ### Security Policies + * + * * 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. + * Swagger Name: AvaTaxClient + * + * @param string $country The two-character ISO-3166 code for the country. + * @param string $region The two or three character region code for the region. + * @param string $effectiveDate Used to limit the jurisnames returned. + * @param string $endDate Used to limit the jurisnames returned. + * @param string $filter 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/). + * @param int $top 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. + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryJurisNames($country, $region, $effectiveDate, $endDate, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/compliance/jurisnames/{$country}/{$region}"; + $guzzleParams = [ + 'query' => ['effectiveDate' => $effectiveDate, 'endDate' => $endDate, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all RateOptions. + * + * This API is available by invitation only. + * + * ### Security Policies + * + * * 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. + * Swagger Name: AvaTaxClient + * + * @param string $country The two-character ISO-3166 code for the country. + * @param string $region The two or three character region code for the region. + * @param string $effectiveDate Used to limit the jurisdictions or rates returned. + * @param string $endDate Used to limit the jurisdictions or rates returned. + * @param string $aggregationOption Aggregation method used. (See StackAggregationOption::* for a list of allowable values) + * @param int $top 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. + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @param string $filter 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/).
*Not filterable:* taxRegionId, taxTypeCodeName, taxSubTypeCode, taxSubTypeCodeName, rateTypeCodeName, componentRate, taxAuthorityId, cityName, countyName, effDate, endDate + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryRateOptions($country, $region, $effectiveDate, $endDate, $aggregationOption, $top=null, $skip=null, $filter=null, $orderBy=null) { + $path = "/api/v2/compliance/rateOptions/{$country}/{$region}"; + $guzzleParams = [ + 'query' => ['effectiveDate' => $effectiveDate, 'endDate' => $endDate, 'aggregationOption' => $aggregationOption, '$top' => $top, '$skip' => $skip, '$filter' => $filter, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve StateConfig information + * + * This API is available by invitation only. + * + * ### Security Policies + * + * * 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. + * Swagger Name: AvaTaxClient + * + * @param string $filter 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/).
*Not filterable:* effDate, endDate, hasBoundary, hasRates, isLocalAdmin, isLocalNexus, isSerState, minBoundaryLevelId, sstStatusId, state, stateFips, boundaryTableBaseName, stjCount, tsStateId, isJaasEnabled, hasSSTBoundary + * @param int $top 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. + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryStateConfig($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/compliance/stateconfig"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all State Reporting Codes based on filter. + * + * ### Security Policies + * + * * 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. + * Swagger Name: AvaTaxClient + * + * @param string $country The two-character ISO-3166 code for the country. + * @param string $region The two or three character region code for the region. + * @param string $effectiveDate Used to limit the StateReportingCodes or rates returned. + * @param string $endDate Used to limit the StateReportingCodes or rates returned. + * @param string $filter 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/).
*Not filterable:* label + * @param int $top 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. + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryStateReportingCodes($country, $region, $effectiveDate, $endDate, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/compliance/stateReportingCodes/{$country}/{$region}"; + $guzzleParams = [ + 'query' => ['effectiveDate' => $effectiveDate, 'endDate' => $endDate, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all tax type mappings based on filter. + * + * ### Security Policies + * + * * 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. + * Swagger Name: AvaTaxClient + * + * @param string $filter 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/).
*Not filterable:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId + * @param int $top 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. + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryTaxTypeMappings($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/compliance/taxtypemappings"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + /** * Create a new contact * @@ -2762,7 +2894,7 @@ public function updateCostCenter($companyid, $costcenterid, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -2797,7 +2929,7 @@ public function createCustomers($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -2838,7 +2970,7 @@ public function deleteCustomer($companyId, $customerCode) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -2877,7 +3009,7 @@ public function getCustomer($companyId, $customerCode, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded the provided customer @@ -2913,7 +3045,7 @@ public function linkAttributesToCustomer($companyId, $customerCode, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -2950,7 +3082,7 @@ public function linkCertificatesToCustomer($companyId, $customerCode, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company defining customers. @@ -2989,7 +3121,7 @@ public function linkShipToCustomersToBillCustomer($companyId, $code, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded the provided customer @@ -3024,7 +3156,7 @@ public function listAttributesForCustomer($companyId, $customerCode) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -3067,7 +3199,7 @@ public function listCertificatesForCustomer($companyId, $customerCode, $include= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -3109,7 +3241,7 @@ public function listValidCertificatesForCustomer($companyId, $customerCode, $cou * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -3151,7 +3283,7 @@ public function queryCustomers($companyId, $include=null, $filter=null, $top=nul * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded the customer @@ -3187,7 +3319,7 @@ public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -3223,7 +3355,7 @@ public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer @@ -3859,7 +3991,7 @@ public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orde * The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API. * Swagger Name: AvaTaxClient * - * @param string $filter 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/).
*Not filterable:* rate, salesRate, signatureCode, useRate, isAcm, isSst + * @param string $filter 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/).
*Not filterable:* rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId * @param int $top 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. @@ -3951,7 +4083,7 @@ public function listJurisdictionsByRateTypeTaxTypeMapping($country, $taxTypeId, * The rate, salesRate, and useRate fields are not available on the JurisdictionHirearchyModels returned by this API. * Swagger Name: AvaTaxClient * - * @param string $filter 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/).
*Not filterable:* parentId, nexus, rate, salesRate, signatureCode, useRate, isAcm, isSst + * @param string $filter 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/).
*Not filterable:* parentId, nexus, rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId * @param int $top 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. @@ -5709,37 +5841,6 @@ public function revokeFirmClientLinkage($id) { return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); } - /** - * FREE API - Request a free trial of AvaTax - * - * Call this API to obtain a free AvaTax account. - * - * This API is free to use. No authentication credentials are required to call this API. You must read and - * accept [Avalara's terms and conditions](https://www1.avalara.com/us/en/legal/terms.html) for the account to be - * created. - * - * If all conditions are met, this API will grant a free trial version of AvaTax. For a list of functionality - * available in the free trial and its limitations, please see the [AvaTax Developer Website Free Trial page](https://developer.avalara.com/avatax/signup/). - * - * After your free trial concludes, you will still be able to use the [Free AvaTax API Suite](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Free/). - * - * ### Security Policies - * - * * This API may be called without providing authentication credentials. - * Swagger Name: AvaTaxClient - * - * @param FreeTrialRequestModel $model Required information to provision a free trial account. - * @return \stdClass - */ - public function requestFreeTrial($model) { - $path = "/api/v2/accounts/freetrials/request"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; - return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - /** * Request the javascript for a funding setup widget * diff --git a/src/Models.php b/src/Models.php index c078b25..475302c 100644 --- a/src/Models.php +++ b/src/Models.php @@ -536,6 +536,12 @@ class AddressValidationInfo * * In the United States, some jurisdictions recognize the address types `pointOfOrderOrigin` and `pointOfOrderAcceptance`. * These address types affect the sourcing models of some transactions. + * + * VAT transactions support a `goodsPlaceOrServiceRendered` address, which indicates where goods are located or where services + * are rendered. VAT transactions also support an `import` address, which specifies the address of the buyer importing a good + * from another country. + * + * India GST transactions support a `billTo` address, which specifies where invoices and other billing-related information are sent to the buyer. * * If latitude and longitude information is provided for any of these addresses along with line, city, region, country and postal code information, * we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. @@ -2559,6 +2565,172 @@ class ComplianceJurisdictionRateModel */ public $taxAuthorityId; } +/** + * Model for RateOption. + * Swagger Name: AvaTaxClient + */ +class ComplianceRateOptionModel +{ + /** + * @var string The name of the Jurisdiction + */ + public $jurisName; + /** + * @var string The Group Code + */ + public $groupCode; + /** + * @var int The id of the tax region. + */ + public $taxRegionId; + /** + * @var string The name of the tax region. + */ + public $taxRegionName; + /** + * @var string The report level. + */ + public $reportLevel; + /** + * @var string The Tax Type Code. + */ + public $taxTypeCode; + /** + * @var string The name of the Tax Type Code. + */ + public $taxTypeCodeName; + /** + * @var string The Sub Type Code. + */ + public $taxSubTypeCode; + /** + * @var string The name of Sub Type. + */ + public $taxSubTypeCodeName; + /** + * @var string The rate type of the rate. + */ + public $rateTypeCode; + /** + * @var string The rate type description. + */ + public $rateTypeCodeName; + /** + * @var float The Stack Rate + */ + public $stackRate; + /** + * @var float The Component Rate + */ + public $componentRate; + /** + * @var int The id of the tax authority. + */ + public $taxAuthorityId; + /** + * @var string City + */ + public $cityName; + /** + * @var string County + */ + public $countyName; + /** + * @var string Effective Date + */ + public $effDate; + /** + * @var string End date + */ + public $endDate; +} +/** + * A flattened model for State Config. + * Swagger Name: AvaTaxClient + */ +class ComplianceStateConfigModel +{ + /** + * @var int The Id of the StateConfig. + */ + public $stateConfigId; + /** + * @var string The Effective Date + */ + public $effDate; + /** + * @var string The End Date + */ + public $endDate; + /** + * @var boolean Has Boundary + */ + public $hasBoundary; + /** + * @var boolean Has Rates + */ + public $hasRates; + /** + * @var boolean Is Local Admin + */ + public $isLocalAdmin; + /** + * @var boolean Is Local Nexus + */ + public $isLocalNexus; + /** + * @var boolean IsSerState + */ + public $isSerState; + /** + * @var int Min Boundary LevelId + */ + public $minBoundaryLevelId; + /** + * @var int Sst Status Id + */ + public $sstStatusId; + /** + * @var string Short name of State. + */ + public $state; + /** + * @var string StateFips + */ + public $stateFips; + /** + * @var string The name of the State. + */ + public $stateName; + /** + * @var string Boundary Table BaseName + */ + public $boundaryTableBaseName; + /** + * @var int STJCount + */ + public $stjCount; + /** + * @var string TsState Id + */ + public $tsStateId; + /** + * @var string The name of the country. + */ + public $country; + /** + * @var int IsJaasEnabled + */ + public $isJaasEnabled; + /** + * @var boolean The name of the country. + */ + public $hasSSTBoundary; + /** + * @var string The name of the country. + */ + public $modifiedDate; +} /** * The tax rate model. * Swagger Name: AvaTaxClient @@ -7833,6 +8005,17 @@ class ItemUploadErrorModel */ public $errors; } +/** + * Represents JurisName Model + * Swagger Name: AvaTaxClient + */ +class JurisNameModel +{ + /** + * @var string Value + */ + public $jurisName; +} /** * Represents information about a single legal taxing jurisdiction with parent jurisdiction * Swagger Name: AvaTaxClient @@ -7927,6 +8110,22 @@ class JurisdictionHierarchyModel * @var boolean The isSst specific to this jurisdiction. */ public $isSst; + /** + * @var string The CreateDate specific to this jurisdiction. + */ + public $createDate; + /** + * @var boolean IsLocalAdmin. + */ + public $isLocalAdmin; + /** + * @var string ModifiedDate + */ + public $modifiedDate; + /** + * @var int TaxAuthorityTypeId. + */ + public $taxAuthorityTypeId; } /** * Represents information about a single legal taxing jurisdiction @@ -8014,6 +8213,22 @@ class JurisdictionModel * @var boolean The isSst specific to this jurisdiction. */ public $isSst; + /** + * @var string The CreateDate specific to this jurisdiction. + */ + public $createDate; + /** + * @var boolean IsLocalAdmin. + */ + public $isLocalAdmin; + /** + * @var string ModifiedDate + */ + public $modifiedDate; + /** + * @var int TaxAuthorityTypeId. + */ + public $taxAuthorityTypeId; } /** * Model to represent the detail of NexusTaxTpeGroup and TaxName for Jurisdiction @@ -9698,6 +9913,10 @@ class NoticeCommentModel * @var int resourceFileId */ public $resourceFileId; + /** + * @var int documentId + */ + public $documentId; /** * @var string The date/time when this record was last modified. */ @@ -9850,6 +10069,10 @@ class NoticeFinanceModel * @var int The ResourceFileId of the finance detail attachment */ public $resourceFileId; + /** + * @var int documentId + */ + public $documentId; /** * @var string The date when this record was created. */ @@ -11079,6 +11302,25 @@ class RemoveTransactionLineModel */ public $renumber; } +/** + * Represents ReportCodeOption Model + * Swagger Name: AvaTaxClient + */ +class ReportCodeOptionModel +{ + /** + * @var string Value + */ + public $stateAssignedCode; + /** + * @var string Label + */ + public $label; + /** + * @var string JurisName + */ + public $jurisName; +} /** * A model for displaying report task metadata * Swagger Name: AvaTaxClient @@ -12015,6 +12257,10 @@ class TaxRegionJurisdictionModel * @var string The date in which this tax region jurisdiction stops to take effect. */ public $endDate; + /** + * @var string The modifiedDate of the tax region jurisdiction. + */ + public $modifiedDate; } /** * The tax region model. @@ -12358,6 +12604,53 @@ class TaxTypeGroupModel */ public $displaySequence; } +/** + * Represents TaxTypeMapping Model + * Swagger Name: AvaTaxClient + */ +class TaxTypeMappingModel +{ + /** + * @var int TaxTypeMappingId + */ + public $taxTypeMappingId; + /** + * @var int TaxTypeGroupIdSK + */ + public $taxTypeGroupIdSK; + /** + * @var int TaxTypeIdSK + */ + public $taxTypeIdSK; + /** + * @var int TaxSubTypeIdSK + */ + public $taxSubTypeIdSK; + /** + * @var int GeneralOrStandardRateTypeIdSK + */ + public $generalOrStandardRateTypeIdSK; + /** + * @var string TaxTypeGroupId + */ + public $taxTypeGroupId; + /** + * @var string TaxTypeId + */ + public $taxTypeId; + /** + * @var string TaxSubTypeId + */ + public $taxSubTypeId; + /** + * @var string Country + */ + public $country; + /** + * @var string GeneralOrStandardRateTypeId + */ + public $generalOrStandardRateTypeId; +} /** * Represents a tax type * Swagger Name: AvaTaxClient