From 7f51cdb632dff6c6e3c4d8edb933cb2e7e72b7d7 Mon Sep 17 00:00:00 2001 From: "SANJUAN\\sachin.baijal" Date: Tue, 14 Dec 2021 11:42:25 -0800 Subject: [PATCH 1/3] Fixes for AVS and DEVPORT-764 --- src/Client.php | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/src/Client.php b/src/Client.php index 142bfa0..fa3ffaf 100644 --- a/src/Client.php +++ b/src/Client.php @@ -155,11 +155,11 @@ public function getClient() * @param string $apiUrl The relative path of the API on the server * @param string $verb The HTTP verb being used in this request * @param string $guzzleParams The Guzzle parameters for this request, including query string and body parameters - * + * @param string $apiversion API Version of the request * @throws \GuzzleHttp\Exception\GuzzleException * @throws \Exception */ - protected function restCall($apiUrl, $verb, $guzzleParams) + protected function restCall($apiUrl, $verb, $guzzleParams, $apiversion='') { // Set authentication on the parameters if (count($this->auth) == 2) { @@ -168,16 +168,16 @@ protected function restCall($apiUrl, $verb, $guzzleParams) } $guzzleParams['headers'] = [ 'Accept' => 'application/json', - 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; 21.10.0; {$this->machineName}" + 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; {$apiversion}; {$this->machineName}" ]; } else { $guzzleParams['headers'] = [ 'Accept' => 'application/json', 'Authorization' => 'Bearer '.$this->auth[0], - 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; 21.10.0; {$this->machineName}" + 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; {$apiversion}; {$this->machineName}" ]; } - + // Check the client config, if set - update guzzleParams['timeout'] if (isset($this->client->getConfig()['timeout']) ) { $guzzleParams['timeout'] = $this->client->getConfig()['timeout']; @@ -186,7 +186,7 @@ protected function restCall($apiUrl, $verb, $guzzleParams) if (!isset($guzzleParams['timeout'])) { $guzzleParams['timeout'] = 1200; } - + // Check the client config, if set - update guzzleParams['connect_timeout'] if (isset($this->client->getConfig()['connect_timeout'])) { $guzzleParams['connect_timeout'] = $this->client->getConfig()['connect_timeout']; @@ -199,20 +199,36 @@ protected function restCall($apiUrl, $verb, $guzzleParams) // Contact the server try { $response = $this->client->request($verb, $apiUrl, $guzzleParams); - $body = $response->getBody(); + $length = 0; + + $contentLength =$response->getHeader('Content-Length'); + if ($contentLength!=null) + { + $length=$contentLength[0]; + } + $code=$response->getStatusCode(); + $contentTypes = $response->getHeader('Content-Type'); + + if ( in_array ("application/json",$contentTypes)) + { + if ($length ==0 and intdiv($code , 100) ==2 ){ + return null; + } + } $JsonBody = json_decode($body); if (is_null($JsonBody)) { - if (json_last_error() === JSON_ERROR_SYNTAX) { - throw new \Exception('The response is in unexpected format. The response is: ' . $JsonBody); - } + if (json_last_error() === JSON_ERROR_SYNTAX) { + throw new \Exception('The response is in unexpected format. The response is: ' . $JsonBody); + } return $body; } else { return $JsonBody; } } catch (\Exception $e) { + echo "in excpetion"; if (!$this->catchExceptions) { throw $e; } From 833eadea4d8f582641183b72519a04e3048dc23e Mon Sep 17 00:00:00 2001 From: svc-developer Date: Tue, 14 Dec 2021 21:56:31 +0000 Subject: [PATCH 2/3] 21.12.0 --- src/Constants.php | 115 ++++ src/Methods.php | 1613 ++++++++++++++++++++++++++------------------- src/Models.php | 589 +++++++++++++++-- 3 files changed, 1561 insertions(+), 756 deletions(-) diff --git a/src/Constants.php b/src/Constants.php index da838bd..d9b9e2c 100644 --- a/src/Constants.php +++ b/src/Constants.php @@ -27,6 +27,7 @@ class TransactionAddressType /** + * Swagger Name: AvaTaxClient * */ class TssAccountMigrationId @@ -39,6 +40,7 @@ class TssAccountMigrationId } /** + * Swagger Name: AvaTaxClient * */ class TextCase @@ -48,6 +50,7 @@ class TextCase } /** + * Swagger Name: AvaTaxClient * */ class DocumentType @@ -68,6 +71,7 @@ class DocumentType } /** + * Swagger Name: AvaTaxClient * */ class CertificatePreviewType @@ -77,6 +81,7 @@ class CertificatePreviewType } /** + * Swagger Name: AvaTaxClient * */ class FilingFrequencyId @@ -92,6 +97,7 @@ class FilingFrequencyId } /** + * Swagger Name: AvaTaxClient * */ class FilingStatusId @@ -116,6 +122,7 @@ class FilingStatusId } /** + * Swagger Name: AvaTaxClient * */ class PointOfSaleFileType @@ -126,6 +133,7 @@ class PointOfSaleFileType } /** + * Swagger Name: AvaTaxClient * */ class PointOfSalePartnerId @@ -135,6 +143,17 @@ class PointOfSalePartnerId } /** + * Swagger Name: AvaTaxClient + * + */ +class UserDefinedFieldType +{ const C_DOCUMENT = 1; + const C_LINE = 2; + +} + +/** + * Swagger Name: AvaTaxClient * */ class SecurityRoleId @@ -167,6 +186,7 @@ class SecurityRoleId } /** + * Swagger Name: AvaTaxClient * */ class PasswordStatusId @@ -177,6 +197,7 @@ class PasswordStatusId } /** + * Swagger Name: AvaTaxClient * */ class AccountStatusId @@ -188,6 +209,7 @@ class AccountStatusId } /** + * Swagger Name: AvaTaxClient * */ class AccountTypeId @@ -198,6 +220,7 @@ class AccountTypeId } /** + * Swagger Name: AvaTaxClient * */ class ErrorCodeId @@ -557,6 +580,7 @@ class ErrorCodeId } /** + * Swagger Name: AvaTaxClient * */ class SeverityLevel @@ -568,6 +592,7 @@ class SeverityLevel } /** + * Swagger Name: AvaTaxClient * */ class JurisdictionType @@ -580,6 +605,7 @@ class JurisdictionType } /** + * Swagger Name: AvaTaxClient * */ class ResolutionQuality @@ -599,6 +625,7 @@ class ResolutionQuality } /** + * Swagger Name: AvaTaxClient * */ class AddressTypeId @@ -609,6 +636,7 @@ class AddressTypeId } /** + * Swagger Name: AvaTaxClient * */ class AddressCategoryId @@ -624,6 +652,7 @@ class AddressCategoryId } /** + * Swagger Name: AvaTaxClient * */ class JurisTypeId @@ -636,6 +665,7 @@ class JurisTypeId } /** + * Swagger Name: AvaTaxClient * */ class NexusTypeId @@ -648,6 +678,7 @@ class NexusTypeId } /** + * Swagger Name: AvaTaxClient * */ class Sourcing @@ -658,6 +689,7 @@ class Sourcing } /** + * Swagger Name: AvaTaxClient * */ class LocalNexusTypeId @@ -668,6 +700,7 @@ class LocalNexusTypeId } /** + * Swagger Name: AvaTaxClient * */ class MatchingTaxType @@ -709,6 +742,7 @@ class MatchingTaxType } /** + * Swagger Name: AvaTaxClient * */ class RateType @@ -732,6 +766,7 @@ class RateType } /** + * Swagger Name: AvaTaxClient * */ class TaxRuleTypeId @@ -749,6 +784,7 @@ class TaxRuleTypeId } /** + * Swagger Name: AvaTaxClient * */ class ExemptCertTypeId @@ -758,6 +794,7 @@ class ExemptCertTypeId } /** + * Swagger Name: AvaTaxClient * */ class ExemptCertStatusId @@ -769,6 +806,7 @@ class ExemptCertStatusId } /** + * Swagger Name: AvaTaxClient * */ class ExemptCertReviewStatusId @@ -779,6 +817,7 @@ class ExemptCertReviewStatusId } /** + * Swagger Name: AvaTaxClient * */ class RoundingLevelId @@ -788,6 +827,7 @@ class RoundingLevelId } /** + * Swagger Name: AvaTaxClient * */ class TaxDependencyLevelId @@ -799,6 +839,7 @@ class TaxDependencyLevelId } /** + * Swagger Name: AvaTaxClient * */ class FormTypeId @@ -816,6 +857,7 @@ class FormTypeId } /** + * Swagger Name: AvaTaxClient * */ class FilingOptionTypeId @@ -826,6 +868,7 @@ class FilingOptionTypeId } /** + * Swagger Name: AvaTaxClient * */ class DueDateTypeId @@ -836,6 +879,7 @@ class DueDateTypeId } /** + * Swagger Name: AvaTaxClient * */ class RoundingTypeId @@ -847,6 +891,7 @@ class RoundingTypeId } /** + * Swagger Name: AvaTaxClient * */ class OutletTypeId @@ -858,6 +903,7 @@ class OutletTypeId } /** + * Swagger Name: AvaTaxClient * */ class BatchType @@ -879,6 +925,7 @@ class BatchType } /** + * Swagger Name: AvaTaxClient * */ class BatchStatus @@ -896,6 +943,7 @@ class BatchStatus } /** + * Swagger Name: AvaTaxClient * */ class TaxOverrideType @@ -911,6 +959,7 @@ class TaxOverrideType } /** + * Swagger Name: AvaTaxClient * */ class MarketplaceLiabilityType @@ -920,6 +969,7 @@ class MarketplaceLiabilityType } /** + * Swagger Name: AvaTaxClient * */ class ServiceMode @@ -930,6 +980,7 @@ class ServiceMode } /** + * Swagger Name: AvaTaxClient * */ class TaxDebugLevel @@ -939,6 +990,7 @@ class TaxDebugLevel } /** + * Swagger Name: AvaTaxClient * */ class DeliveryTerms @@ -948,6 +1000,7 @@ class DeliveryTerms } /** + * Swagger Name: AvaTaxClient * */ class AdjustmentReason @@ -965,6 +1018,7 @@ class AdjustmentReason } /** + * Swagger Name: AvaTaxClient * */ class VoidReasonCode @@ -977,6 +1031,7 @@ class VoidReasonCode } /** + * Swagger Name: AvaTaxClient * */ class CertificateRequestDeliveryMethod @@ -987,6 +1042,7 @@ class CertificateRequestDeliveryMethod } /** + * Swagger Name: AvaTaxClient * */ class CertExpressInvitationStatus @@ -996,6 +1052,7 @@ class CertExpressInvitationStatus } /** + * Swagger Name: AvaTaxClient * */ class CertCaptureProvisionStatus @@ -1006,6 +1063,7 @@ class CertCaptureProvisionStatus } /** + * Swagger Name: AvaTaxClient * */ class CompanyFilingStatus @@ -1020,6 +1078,7 @@ class CompanyFilingStatus } /** + * Swagger Name: AvaTaxClient * */ class Visibility @@ -1031,6 +1090,7 @@ class Visibility } /** + * Swagger Name: AvaTaxClient * */ class ScraperType @@ -1040,6 +1100,7 @@ class ScraperType } /** + * Swagger Name: AvaTaxClient * */ class BoundaryLevel @@ -1050,6 +1111,7 @@ class BoundaryLevel } /** + * Swagger Name: AvaTaxClient * */ class AvataxDeleteErrorTransactionStatus @@ -1059,6 +1121,7 @@ class AvataxDeleteErrorTransactionStatus } /** + * Swagger Name: AvaTaxClient * */ class FilingTypeId @@ -1073,6 +1136,7 @@ class FilingTypeId } /** + * Swagger Name: AvaTaxClient * */ class BulkAccountValidationStatus @@ -1083,6 +1147,7 @@ class BulkAccountValidationStatus } /** + * Swagger Name: AvaTaxClient * */ class FilingRequestStatus @@ -1099,6 +1164,7 @@ class FilingRequestStatus } /** + * Swagger Name: AvaTaxClient * */ class AccrualType @@ -1108,6 +1174,7 @@ class AccrualType } /** + * Swagger Name: AvaTaxClient * */ class AdjustmentPeriodTypeId @@ -1118,6 +1185,7 @@ class AdjustmentPeriodTypeId } /** + * Swagger Name: AvaTaxClient * */ class PaymentAccountTypeId @@ -1129,6 +1197,7 @@ class PaymentAccountTypeId } /** + * Swagger Name: AvaTaxClient * */ class PaymentType @@ -1140,6 +1209,7 @@ class PaymentType } /** + * Swagger Name: AvaTaxClient * */ class WorksheetTypeId @@ -1150,6 +1220,7 @@ class WorksheetTypeId } /** + * Swagger Name: AvaTaxClient * */ class FirmClientLinkageStatus @@ -1161,6 +1232,7 @@ class FirmClientLinkageStatus } /** + * Swagger Name: AvaTaxClient * */ class LiabilityType @@ -1170,6 +1242,7 @@ class LiabilityType } /** + * Swagger Name: AvaTaxClient * */ class DeemedSellerType @@ -1179,6 +1252,7 @@ class DeemedSellerType } /** + * Swagger Name: AvaTaxClient * */ class DocumentStatus @@ -1195,6 +1269,7 @@ class DocumentStatus } /** + * Swagger Name: AvaTaxClient * */ class RefundType @@ -1206,6 +1281,7 @@ class RefundType } /** + * Swagger Name: AvaTaxClient * */ class ApiCallStatus @@ -1216,6 +1292,7 @@ class ApiCallStatus } /** + * Swagger Name: AvaTaxClient * */ class CommentType @@ -1227,6 +1304,7 @@ class CommentType } /** + * Swagger Name: AvaTaxClient * */ class NoticeCustomerType @@ -1243,6 +1321,7 @@ class NoticeCustomerType } /** + * Swagger Name: AvaTaxClient * */ class TaxNoticeFilingTypeId @@ -1260,6 +1339,7 @@ class TaxNoticeFilingTypeId } /** + * Swagger Name: AvaTaxClient * */ class FundingOption @@ -1269,6 +1349,7 @@ class FundingOption } /** + * Swagger Name: AvaTaxClient * */ class NoticePriorityId @@ -1280,6 +1361,7 @@ class NoticePriorityId } /** + * Swagger Name: AvaTaxClient * */ class NotificationSeverityLevel @@ -1291,6 +1373,7 @@ class NotificationSeverityLevel } /** + * Swagger Name: AvaTaxClient * */ class ReportFormat @@ -1299,6 +1382,7 @@ class ReportFormat } /** + * Swagger Name: AvaTaxClient * */ class ReportDateFilter @@ -1311,6 +1395,7 @@ class ReportDateFilter } /** + * Swagger Name: AvaTaxClient * */ class ReportDocType @@ -1320,6 +1405,7 @@ class ReportDocType } /** + * Swagger Name: AvaTaxClient * */ class SendSalesOutputFileFormat @@ -1330,6 +1416,7 @@ class SendSalesOutputFileFormat } /** + * Swagger Name: AvaTaxClient * */ class SendSalesFileType @@ -1339,6 +1426,19 @@ class SendSalesFileType } /** + * Swagger Name: AvaTaxClient + * + */ +class UserDefinedFieldDataType +{ const C_STRING = 0; + const C_NUMBER = 1; + const C_DATE = 2; + const C_BOOLEAN = 3; + +} + +/** + * Swagger Name: AvaTaxClient * */ class CompanyAccessLevel @@ -1351,6 +1451,7 @@ class CompanyAccessLevel } /** + * Swagger Name: AvaTaxClient * */ class AuthenticationTypeId @@ -1359,5 +1460,19 @@ class AuthenticationTypeId const C_ACCOUNTIDLICENSEKEY = 2; const C_OPENIDBEARERTOKEN = 3; +} + +/** + * Swagger Name: AvaTaxBeverageClient + * + */ +class AgeVerifyFailureCode +{ const C_NOT_FOUND = 0; + const C_DOB_UNVERIFIABLE = 1; + const C_UNDER_AGE = 2; + const C_SUSPECTED_FRAUD = 3; + const C_DECEASED = 4; + const C_UNKNOWN_ERROR = 5; + } ?> \ No newline at end of file diff --git a/src/Methods.php b/src/Methods.php index 94e16c8..009434d 100644 --- a/src/Methods.php +++ b/src/Methods.php @@ -41,7 +41,7 @@ class AvaTaxClient extends AvaTaxClientBase * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account you wish to update. * @param ResetLicenseKeyModel $model A request confirming that you wish to reset the license key of this account. @@ -53,7 +53,7 @@ public function accountResetLicenseKey($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -73,7 +73,7 @@ public function accountResetLicenseKey($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account to activate * @param ActivateAccountModel $model The activation request @@ -85,7 +85,7 @@ public function activateAccount($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -109,7 +109,7 @@ public function activateAccount($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account you wish to audit. * @param string $start The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes. @@ -124,7 +124,7 @@ public function auditAccount($id, $start, $end, $top=null, $skip=null) { 'query' => ['start' => $start, 'end' => $end, '$top' => $top, '$skip' => $skip], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -144,7 +144,7 @@ public function auditAccount($id, $start, $end, $top=null, $skip=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account you wish to update. * @param AccountLicenseKeyModel $model @@ -156,7 +156,7 @@ public function createLicenseKey($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -171,7 +171,7 @@ public function createLicenseKey($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account you wish to update. * @param string $licensekeyname The license key name you wish to update. @@ -183,7 +183,7 @@ public function deleteLicenseKey($id, $licensekeyname) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -198,7 +198,7 @@ public function deleteLicenseKey($id, $licensekeyname) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account to retrieve * @param string $include A comma separated list of special fetch options @@ -210,7 +210,7 @@ public function getAccount($id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -232,7 +232,7 @@ public function getAccount($id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return AccountConfigurationModel[] @@ -243,7 +243,7 @@ public function getAccountConfiguration($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -252,7 +252,7 @@ public function getAccountConfiguration($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account to retrieve * @param string $licensekeyname The ID of the account to retrieve @@ -264,7 +264,7 @@ public function getLicenseKey($id, $licensekeyname) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -275,7 +275,7 @@ public function getLicenseKey($id, $licensekeyname) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account to retrieve * @return AccountLicenseKeyModel[] @@ -286,7 +286,7 @@ public function getLicenseKeys($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -308,7 +308,7 @@ public function getLicenseKeys($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param string $include A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name. * @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:* subscriptions, users @@ -323,7 +323,7 @@ public function queryAccounts($include=null, $filter=null, $top=null, $skip=null 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -345,7 +345,7 @@ public function queryAccounts($include=null, $filter=null, $top=null, $skip=null * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id * @param AccountConfigurationModel[] $model @@ -357,7 +357,7 @@ public function setAccountConfiguration($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -379,7 +379,7 @@ public function setAccountConfiguration($id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AutoAddress. - * + * Swagger Name: AvaTaxClient * * @param string $line1 Line 1 * @param string $line2 Line 2 @@ -397,7 +397,7 @@ public function resolveAddress($line1, $line2, $line3, $city, $region, $postalCo 'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country, 'textCase' => $textCase], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -414,7 +414,7 @@ public function resolveAddress($line1, $line2, $line3, $city, $region, $postalCo * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AutoAddress. - * + * Swagger Name: AvaTaxClient * * @param AddressValidationInfo $model The address to resolve * @return AddressResolutionModel @@ -425,14 +425,14 @@ public function resolveAddressPost($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** * Create a lookup file for a company * * - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account for the company * @param int $companyId The ID of the company for which the lookup file is to be created @@ -445,14 +445,14 @@ public function createCompanyLookupFile($accountId, $companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** * Delete a lookup file * * - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account for the company the lookup file is for * @param string $id The unique ID/GUID for the company lookup file to be deleted @@ -464,14 +464,14 @@ public function deleteLookupFile($accountId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** * Get the lookup files for a company * * - * + * Swagger Name: AvaTaxClient * * @param int $accountId The account ID for the company * @param int $companyId The ID of the company for which to retrieve lookup files @@ -483,14 +483,14 @@ public function getCompanyLookupFiles($accountId, $companyId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Get a lookup file for an accountId and companyLookupFileId * * - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account for the lookup file * @param string $id The unique ID/GUID of the company lookup file to return @@ -502,14 +502,14 @@ public function getLookupFile($accountId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Update a lookup file * * - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account for the company the lookup file is for * @param string $id The unique ID/GUID of the company lookup file to be updated @@ -522,7 +522,7 @@ public function updateLookupFile($accountId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -535,7 +535,7 @@ public function updateLookupFile($accountId, $id, $model) { * * * This API requires the user role Compliance Root User. * * 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 AvaFileFormModel[] $model The AvaFileForm you wish to create. * @return AvaFileFormModel[] @@ -546,7 +546,7 @@ public function createAvaFileForms($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -558,7 +558,7 @@ public function createAvaFileForms($model) { * * * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin. * * 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 int $id The ID of the AvaFileForm you wish to delete. * @return ErrorDetail[] @@ -569,7 +569,7 @@ public function deleteAvaFileForm($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -581,7 +581,7 @@ public function deleteAvaFileForm($id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. * * 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 int $id The primary key of this AvaFileForm * @return AvaFileFormModel @@ -592,7 +592,7 @@ public function getAvaFileForm($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -605,7 +605,7 @@ public function getAvaFileForm($id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin. * * 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:* outletTypeId * @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. @@ -619,7 +619,7 @@ public function queryAvaFileForms($filter=null, $top=null, $skip=null, $orderBy= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -632,7 +632,7 @@ public function queryAvaFileForms($filter=null, $top=null, $skip=null, $orderBy= * * * This API requires the user role Compliance Root User. * * 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 int $id The ID of the AvaFileForm you wish to update * @param AvaFileFormModel $model The AvaFileForm model you wish to update. @@ -644,7 +644,7 @@ public function updateAvaFileForm($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -666,7 +666,7 @@ public function updateAvaFileForm($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this batch. * @param int $id The ID of the batch to cancel. @@ -678,7 +678,7 @@ public function cancelBatch($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -707,7 +707,7 @@ public function cancelBatch($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this batch. * @param BatchModel[] $model The batch you wish to create. @@ -719,7 +719,7 @@ public function createBatches($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -746,7 +746,7 @@ public function createBatches($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this batch. * @param CreateTransactionBatchRequestModel $model The transaction batch you wish to create. @@ -758,7 +758,7 @@ public function createTransactionBatch($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -778,7 +778,7 @@ public function createTransactionBatch($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this batch. * @param int $id The ID of the batch to delete. @@ -790,7 +790,7 @@ public function deleteBatch($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -801,7 +801,7 @@ public function deleteBatch($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this batch * @param int $batchId The ID of the batch object @@ -814,7 +814,7 @@ public function downloadBatch($companyId, $batchId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -839,7 +839,7 @@ public function downloadBatch($companyId, $batchId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this batch * @param int $id The primary key of this batch @@ -851,7 +851,7 @@ public function getBatch($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -882,7 +882,7 @@ public function getBatch($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these batches * @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:* files @@ -898,7 +898,7 @@ public function listBatchesByCompany($companyId, $filter=null, $include=null, $t 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -926,7 +926,7 @@ public function listBatchesByCompany($companyId, $filter=null, $include=null, $t * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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:* files * @param string $include A comma separated list of additional data to retrieve. @@ -941,7 +941,7 @@ public function queryBatches($filter=null, $include=null, $top=null, $skip=null, 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -967,7 +967,7 @@ public function queryBatches($filter=null, $include=null, $top=null, $skip=null, * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that will record certificates * @param string $customerCode The number of the customer where the request is sent to @@ -980,7 +980,7 @@ public function createCertExpressInvitation($companyId, $customerCode, $model) 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1006,7 +1006,7 @@ public function createCertExpressInvitation($companyId, $customerCode, $model) * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that issued this invitation * @param string $customerCode The number of the customer where the request is sent to @@ -1020,7 +1020,7 @@ public function getCertExpressInvitation($companyId, $customerCode, $id, $includ 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1046,7 +1046,7 @@ public function getCertExpressInvitation($companyId, $customerCode, $id, $includ * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that issued this invitation * @param string $include OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. @@ -1062,7 +1062,7 @@ public function listCertExpressInvitations($companyId, $include=null, $filter=nu 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1094,7 +1094,7 @@ public function listCertExpressInvitations($companyId, $include=null, $filter=nu * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company recording this certificate * @param boolean $preValidatedExemptionReason If set to true, the certificate will bypass the human verification process. @@ -1107,7 +1107,7 @@ public function createCertificates($companyId, $preValidatedExemptionReason, $mo 'query' => ['$preValidatedExemptionReason' => $preValidatedExemptionReason], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1131,7 +1131,7 @@ public function createCertificates($companyId, $preValidatedExemptionReason, $mo * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1143,7 +1143,7 @@ public function deleteCertificate($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -1168,7 +1168,7 @@ public function deleteCertificate($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1182,7 +1182,7 @@ public function downloadCertificateImage($companyId, $id, $page, $type) { 'query' => ['$page' => $page, '$type' => $type], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1210,7 +1210,7 @@ public function downloadCertificateImage($companyId, $id, $page, $type) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1223,7 +1223,7 @@ public function getCertificate($companyId, $id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1241,7 +1241,7 @@ public function getCertificate($companyId, $id, $include=null) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company ID to check * @return ProvisionStatusModel @@ -1252,7 +1252,7 @@ public function getCertificateSetup($companyId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1277,7 +1277,7 @@ public function getCertificateSetup($companyId) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1290,7 +1290,7 @@ public function linkAttributesToCertificate($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1316,7 +1316,7 @@ public function linkAttributesToCertificate($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1329,7 +1329,7 @@ public function linkCustomersToCertificate($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1354,7 +1354,7 @@ public function linkCustomersToCertificate($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1366,7 +1366,7 @@ public function listAttributesForCertificate($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1391,7 +1391,7 @@ public function listAttributesForCertificate($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1404,7 +1404,7 @@ public function listCustomersForCertificate($companyId, $id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1432,7 +1432,7 @@ public function listCustomersForCertificate($companyId, $id, $include=null) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company to search * @param string $include 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. @@ -1448,7 +1448,7 @@ public function queryCertificates($companyId, $include=null, $filter=null, $top= 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1468,7 +1468,7 @@ public function queryCertificates($companyId, $include=null, $filter=null, $top= * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId * @return ProvisionStatusModel @@ -1479,7 +1479,7 @@ public function requestCertificateSetup($companyId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1504,7 +1504,7 @@ public function requestCertificateSetup($companyId) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1517,7 +1517,7 @@ public function unlinkAttributesFromCertificate($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1544,7 +1544,7 @@ public function unlinkAttributesFromCertificate($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1557,7 +1557,7 @@ public function unlinkCustomersFromCertificate($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1579,7 +1579,7 @@ public function unlinkCustomersFromCertificate($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1592,7 +1592,7 @@ public function updateCertificate($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -1617,7 +1617,7 @@ public function updateCertificate($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this certificate * @param int $id The unique ID number of this certificate @@ -1630,7 +1630,7 @@ public function uploadCertificateImage($companyId, $id, $file) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1663,7 +1663,7 @@ public function uploadCertificateImage($companyId, $id, $file) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the company to check if its integration is certified. * @return string @@ -1674,7 +1674,7 @@ public function certifyIntegration($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1697,7 +1697,7 @@ public function certifyIntegration($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id * @param FilingStatusChangeModel $model @@ -1709,7 +1709,7 @@ public function changeFilingStatus($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1731,7 +1731,7 @@ public function changeFilingStatus($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param CompanyInitializationModel $model Information about the company you wish to create. * @return CompanyModel @@ -1742,7 +1742,7 @@ public function companyInitialize($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1757,7 +1757,7 @@ public function companyInitialize($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param CompanyModel[] $model Either a single company object or an array of companies to create * @return CompanyModel[] @@ -1768,7 +1768,7 @@ public function createCompanies($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1789,7 +1789,7 @@ public function createCompanies($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this company parameter. * @param CompanyParameterDetailModel[] $model The company parameters you wish to create. @@ -1801,7 +1801,7 @@ public function createCompanyParameters($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1822,7 +1822,7 @@ public function createCompanyParameters($companyId, $model) { * * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The unique identifier of the company * @param FundingInitiateModel $model The funding initialization request @@ -1834,7 +1834,7 @@ public function createFundingRequest($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -1845,7 +1845,7 @@ public function createFundingRequest($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the company you wish to delete. * @return ErrorDetail[] @@ -1856,7 +1856,7 @@ public function deleteCompany($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -1872,7 +1872,7 @@ public function deleteCompany($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $id The parameter id @@ -1884,7 +1884,7 @@ public function deleteCompanyParameter($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -1899,7 +1899,7 @@ public function deleteCompanyParameter($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * 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 int $companyId The unique identifier of the company * @return FundingConfigurationModel @@ -1910,7 +1910,7 @@ public function fundingConfigurationByCompany($companyId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1925,7 +1925,7 @@ public function fundingConfigurationByCompany($companyId) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * 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 int $companyId The unique identifier of the company * @param string $currency The currency of the funding. USD and CAD are the only valid currencies @@ -1937,7 +1937,7 @@ public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) 'query' => ['currency' => $currency], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1960,7 +1960,7 @@ public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the company to retrieve. * @param string $include OPTIONAL: A comma separated list of special fetch options. * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules". * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects. @@ -1972,7 +1972,7 @@ public function getCompany($id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -1994,7 +1994,7 @@ public function getCompany($id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return CompanyConfigurationModel[] @@ -2005,7 +2005,7 @@ public function getCompanyConfiguration($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2022,7 +2022,7 @@ public function getCompanyConfiguration($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId * @param int $id @@ -2034,7 +2034,7 @@ public function getCompanyParameterDetail($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2058,7 +2058,7 @@ public function getCompanyParameterDetail($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return string @@ -2069,7 +2069,7 @@ public function getFilingStatus($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2089,7 +2089,7 @@ public function getFilingStatus($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @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:* name, unit @@ -2104,7 +2104,7 @@ public function listCompanyParameterDetails($companyId, $filter=null, $top=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2119,7 +2119,7 @@ public function listCompanyParameterDetails($companyId, $filter=null, $top=null, * * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp. * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The unique identifier of the company * @return FundingStatusModel[] @@ -2130,7 +2130,7 @@ public function listFundingRequestsByCompany($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2143,7 +2143,7 @@ public function listFundingRequestsByCompany($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @return FetchResult */ @@ -2153,7 +2153,7 @@ public function listMrsCompanies() { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2180,7 +2180,7 @@ public function listMrsCompanies() { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param string $include A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name. * @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers @@ -2195,7 +2195,7 @@ public function queryCompanies($include=null, $filter=null, $top=null, $skip=nul 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2217,7 +2217,7 @@ public function queryCompanies($include=null, $filter=null, $top=null, $skip=nul * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id * @param CompanyConfigurationModel[] $model @@ -2229,7 +2229,7 @@ public function setCompanyConfiguration($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -2250,7 +2250,7 @@ public function setCompanyConfiguration($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the company you wish to update. * @param CompanyModel $model The company object you wish to update. @@ -2262,7 +2262,7 @@ public function updateCompany($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -2279,7 +2279,7 @@ public function updateCompany($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $id The company parameter id @@ -2292,7 +2292,36 @@ public function updateCompanyParameterDetail($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); + } + + /** + * Retrieve jurisdiction rate information for tax authority + * + * 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 int $taxAuthorityId Used to limit the jurisdictions returned. + * @param string $effectiveDate Used to limit the jurisdictions returned. + * @param string $endDate Used to limit the jurisdictions 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 string $include A comma separated list of objects to fetch underneath this jurisdiction. + * @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 ComplianceJurisdictionRateModel + */ + public function queryTaxAuthorityJurisdictionRates($taxAuthorityId, $effectiveDate, $endDate, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/compliance/taxauthorityjurisdictionrates"; + $guzzleParams = [ + 'query' => ['taxAuthorityId' => $taxAuthorityId, 'effectiveDate' => $effectiveDate, 'endDate' => $endDate, '$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2305,7 +2334,7 @@ public function updateCompanyParameterDetail($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this contact. * @param ContactModel[] $model The contacts you wish to create. @@ -2317,7 +2346,7 @@ public function createContacts($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -2328,7 +2357,7 @@ public function createContacts($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this contact. * @param int $id The ID of the contact you wish to delete. @@ -2340,7 +2369,7 @@ public function deleteContact($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -2353,7 +2382,7 @@ public function deleteContact($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company for this contact * @param int $id The primary key of this contact @@ -2365,7 +2394,7 @@ public function getContact($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2379,7 +2408,7 @@ public function getContact($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these contacts * @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/). @@ -2394,7 +2423,7 @@ public function listContactsByCompany($companyId, $filter=null, $top=null, $skip 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2410,7 +2439,7 @@ public function listContactsByCompany($companyId, $filter=null, $top=null, $skip * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * 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/). * @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. @@ -2424,7 +2453,7 @@ public function queryContacts($filter=null, $top=null, $skip=null, $orderBy=null 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2439,7 +2468,7 @@ public function queryContacts($filter=null, $top=null, $skip=null, $orderBy=null * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this contact belongs to. * @param int $id The ID of the contact you wish to update @@ -2452,7 +2481,7 @@ public function updateContact($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -2478,7 +2507,7 @@ public function updateContact($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param CustomerModel[] $model The list of customer objects to be created @@ -2490,7 +2519,7 @@ public function createCustomers($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -2513,7 +2542,7 @@ public function createCustomers($companyId, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $customerCode The unique code representing this customer @@ -2525,7 +2554,7 @@ public function deleteCustomer($companyId, $customerCode) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -2554,7 +2583,7 @@ public function deleteCustomer($companyId, $customerCode) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $customerCode The unique code representing this customer @@ -2567,7 +2596,7 @@ public function getCustomer($companyId, $customerCode, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2593,7 +2622,7 @@ public function getCustomer($companyId, $customerCode, $include=null) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded the provided customer * @param string $customerCode The unique code representing the current customer @@ -2606,7 +2635,7 @@ public function linkAttributesToCustomer($companyId, $customerCode, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -2629,7 +2658,7 @@ public function linkAttributesToCustomer($companyId, $customerCode, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $customerCode The unique code representing this customer @@ -2642,7 +2671,7 @@ public function linkCertificatesToCustomer($companyId, $customerCode, $model) 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -2666,7 +2695,7 @@ public function linkCertificatesToCustomer($companyId, $customerCode, $model) * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company defining customers. * @param string $code The code of the bill-to customer to link. @@ -2679,7 +2708,7 @@ public function linkShipToCustomersToBillCustomer($companyId, $code, $model) 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -2705,7 +2734,7 @@ public function linkShipToCustomersToBillCustomer($companyId, $code, $model) * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded the provided customer * @param string $customerCode The unique code representing the current customer @@ -2717,7 +2746,7 @@ public function listAttributesForCustomer($companyId, $customerCode) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2740,7 +2769,7 @@ public function listAttributesForCustomer($companyId, $customerCode) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $customerCode The unique code representing this customer @@ -2757,7 +2786,7 @@ public function listCertificatesForCustomer($companyId, $customerCode, $include= 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2783,7 +2812,7 @@ public function listCertificatesForCustomer($companyId, $customerCode, $include= * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $customerCode The unique code representing this customer @@ -2797,7 +2826,7 @@ public function listValidCertificatesForCustomer($companyId, $customerCode, $cou 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2825,7 +2854,7 @@ public function listValidCertificatesForCustomer($companyId, $customerCode, $cou * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $include OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer. @@ -2841,7 +2870,7 @@ public function queryCustomers($companyId, $include=null, $filter=null, $top=nul 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -2867,7 +2896,7 @@ public function queryCustomers($companyId, $include=null, $filter=null, $top=nul * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded the customer * @param string $customerCode The unique code representing the current customer @@ -2880,7 +2909,7 @@ public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -2903,7 +2932,7 @@ public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $customerCode The unique code representing this customer @@ -2916,7 +2945,7 @@ public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -2939,7 +2968,7 @@ public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that recorded this customer * @param string $customerCode The unique code representing this customer @@ -2952,7 +2981,7 @@ public function updateCustomer($companyId, $customerCode, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -2964,7 +2993,7 @@ public function updateCustomer($companyId, $customerCode, $model) { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The id of the company you which to create the datasources * @param DataSourceModel[] $model @@ -2976,7 +3005,7 @@ public function createDataSources($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -2988,7 +3017,7 @@ public function createDataSources($companyId, $model) { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The id of the company the datasource belongs to. * @param int $id The id of the datasource you wish to delete. @@ -3000,7 +3029,7 @@ public function deleteDataSource($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -3012,7 +3041,7 @@ public function deleteDataSource($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param int $companyId * @param int $id data source id @@ -3024,7 +3053,7 @@ public function getDataSourceById($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3036,7 +3065,7 @@ public function getDataSourceById($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The id of the company you wish to retrieve the datasources. * @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:* isEnabled, isSynced, isAuthorized, name, externalState @@ -3051,7 +3080,7 @@ public function listDataSources($companyId, $filter=null, $top=null, $skip=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3066,7 +3095,7 @@ public function listDataSources($companyId, $filter=null, $top=null, $skip=null, * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * 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:* isEnabled, isSynced, isAuthorized, name, externalState * @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. @@ -3080,7 +3109,7 @@ public function queryDataSources($filter=null, $top=null, $skip=null, $orderBy=n 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3092,7 +3121,7 @@ public function queryDataSources($filter=null, $top=null, $skip=null, $orderBy=n * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The id of the company the datasource belongs to. * @param int $id The id of the datasource you wish to delete. @@ -3105,7 +3134,7 @@ public function updateDataSource($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -3125,7 +3154,7 @@ public function updateDataSource($companyId, $id, $model) { * ### Security Policies * * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. - * + * Swagger Name: AvaTaxClient * * @param string $country The name or code of the destination country. * @param string $hsCode The partial or full HS Code for which you would like to view all of the parents. @@ -3137,7 +3166,7 @@ public function getCrossBorderCode($country, $hsCode) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3145,7 +3174,7 @@ public function getCrossBorderCode($country, $hsCode) { * * This API is intended to be useful to identify whether the user should be allowed * to automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification. - * + * Swagger Name: AvaTaxClient * * @param string $form The name of the form you would like to verify. This is the tax form code * @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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields @@ -3160,14 +3189,14 @@ public function getLoginVerifierByForm($form, $filter=null, $top=null, $skip=nul 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * List all market place locations. * * List all market place locations. - * + * 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/). * @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. @@ -3181,7 +3210,7 @@ public function listAllMarketplaceLocations($filter=null, $top=null, $skip=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3193,7 +3222,7 @@ public function listAllMarketplaceLocations($filter=null, $top=null, $skip=null, * * Returns the full list of Avalara-supported AvaFile Forms * This API is intended to be useful to identify all the different AvaFile Forms - * + * 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:* outletTypeId * @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. @@ -3207,7 +3236,7 @@ public function listAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=n 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3220,7 +3249,7 @@ public function listAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=n * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to * check and provision account. - * + * Swagger Name: AvaTaxClient * * @param int $companyid Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company. * @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/). @@ -3235,7 +3264,7 @@ public function listCertificateAttributes($companyid, $filter=null, $top=null, $ 'query' => ['companyid' => $companyid, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3248,7 +3277,7 @@ public function listCertificateAttributes($companyid, $filter=null, $top=null, $ * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to * check and provision account. - * + * 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/). * @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. @@ -3262,7 +3291,7 @@ public function listCertificateExemptReasons($filter=null, $top=null, $skip=null 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3275,7 +3304,7 @@ public function listCertificateExemptReasons($filter=null, $top=null, $skip=null * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to * check and provision account. - * + * 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:* id, companyId, name, tag, description, created, modified, region, country * @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. @@ -3289,7 +3318,7 @@ public function listCertificateExposureZones($filter=null, $top=null, $skip=null 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3298,7 +3327,7 @@ public function listCertificateExposureZones($filter=null, $top=null, $skip=null * Returns the full list of Avalara-supported usage of extra parameters for item classification. * The list of parameters is available for use with Item Classification. * Some parameters are only available for use if you have subscribed to certain features of AvaTax. - * + * 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:* 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. @@ -3312,14 +3341,14 @@ public function listClassificationParametersUsage($filter=null, $top=null, $skip 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Retrieve the full list of communications service types * * Returns full list of service types for a given transaction type ID. - * + * Swagger Name: AvaTaxClient * * @param int $id The transaction type ID to examine * @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:* requiredParameters @@ -3334,7 +3363,7 @@ public function listCommunicationsServiceTypes($id, $filter=null, $top=null, $sk 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3342,7 +3371,7 @@ public function listCommunicationsServiceTypes($id, $filter=null, $top=null, $sk * * Returns full list of communications transaction types which * are accepted in communication tax calculation requests. - * + * 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/). * @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. @@ -3356,7 +3385,7 @@ public function listCommunicationsTransactionTypes($filter=null, $top=null, $ski 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3364,7 +3393,7 @@ public function listCommunicationsTransactionTypes($filter=null, $top=null, $ski * * Returns full list of communications transaction/service type pairs which * are accepted in communication tax calculation requests. - * + * 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:* requiredParameters * @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. @@ -3378,7 +3407,7 @@ public function listCommunicationsTSPairs($filter=null, $top=null, $skip=null, $ 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3387,7 +3416,7 @@ public function listCommunicationsTSPairs($filter=null, $top=null, $skip=null, $ * Returns a list of all ISO 3166 country codes, and their US English friendly names. * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for * a shipping address. - * + * 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:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion * @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. @@ -3401,7 +3430,7 @@ public function listCountries($filter=null, $top=null, $skip=null, $orderBy=null 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3415,7 +3444,7 @@ public function listCountries($filter=null, $top=null, $skip=null, $orderBy=null * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to * check and provision account. - * + * 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:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version * @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. @@ -3429,7 +3458,7 @@ public function listCoverLetters($filter=null, $top=null, $skip=null, $orderBy=n 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3447,7 +3476,7 @@ public function listCoverLetters($filter=null, $top=null, $skip=null, $orderBy=n * ### Security Policies * * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. - * + * Swagger Name: AvaTaxClient * * @param string $country The name or code of the destination country. * @param string $hsCode The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available. @@ -3463,7 +3492,7 @@ public function listCrossBorderCodes($country, $hsCode, $filter=null, $top=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3479,7 +3508,7 @@ public function listCrossBorderCodes($country, $hsCode, $filter=null, $top=null, * ### Security Policies * * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. - * + * Swagger Name: AvaTaxClient * * @return FetchResult */ @@ -3489,7 +3518,7 @@ public function listCrossBorderSections() { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3499,7 +3528,7 @@ public function listCrossBorderSections() { * * This API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the * `currencyCode` field in a `CreateTransactionModel`. - * + * 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/). * @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. @@ -3513,7 +3542,7 @@ public function listCurrencies($filter=null, $top=null, $skip=null, $orderBy=nul 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3524,7 +3553,7 @@ public function listCurrencies($filter=null, $top=null, $skip=null, $orderBy=nul * is occurring. This information is generally used to determine taxability of the product. * In order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for * all transactions that are exempt. - * + * 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:* validCountries * @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. @@ -3538,7 +3567,7 @@ public function listEntityUseCodes($filter=null, $top=null, $skip=null, $orderBy 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3546,7 +3575,7 @@ public function listEntityUseCodes($filter=null, $top=null, $skip=null, $orderBy * * Returns the full list of Avalara-supported filing frequencies. * This API is intended to be useful to identify all the different filing frequencies that can be used in notices. - * + * 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/). * @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. @@ -3560,7 +3589,7 @@ public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3572,7 +3601,7 @@ public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orde * SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01' * * 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 * @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. @@ -3586,7 +3615,7 @@ public function listJurisdictions($filter=null, $top=null, $skip=null, $orderBy= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3599,7 +3628,7 @@ public function listJurisdictions($filter=null, $top=null, $skip=null, $orderBy= * jurisdiction in AvaTax. * * The results of this API call can be passed to the `CreateJurisdictionOverride` API call. - * + * Swagger Name: AvaTaxClient * * @param string $line1 The first address line portion of this address. * @param string $line2 The second address line portion of this address. @@ -3620,7 +3649,7 @@ public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $regio 'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3632,7 +3661,7 @@ public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $regio * SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01' * * The jurisdictionType, effectiveDate, and endDate are filterable fields available on the JurisdictionRateTypeTaxTypeMappingModels returned by this API. - * + * Swagger Name: AvaTaxClient * * @param string $country The country for which you want to retrieve the jurisdiction information * @param string $region The region for which you want to retrieve the jurisdiction information @@ -3651,7 +3680,7 @@ public function listJurisdictionsByRateTypeTaxTypeMapping($country, $region, $ta 'query' => ['rateTypeId' => $rateTypeId, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3663,7 +3692,7 @@ public function listJurisdictionsByRateTypeTaxTypeMapping($country, $region, $ta * This information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly. * You can call this API call for any address and obtain information about what questions must be answered in order to properly * file tax in that location. - * + * Swagger Name: AvaTaxClient * * @param string $line1 The first line of this location's address. * @param string $line2 The second line of this location's address. @@ -3686,7 +3715,7 @@ public function listLocationQuestionsByAddress($line1, $line2, $line3, $city, $r 'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country, 'latitude' => $latitude, 'longitude' => $longitude, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3695,7 +3724,7 @@ public function listLocationQuestionsByAddress($line1, $line2, $line3, $city, $r * List all forms where logins can be verified automatically. * This API is intended to be useful to identify whether the user should be allowed * to automatically verify their login and password. - * + * 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:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields * @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. @@ -3709,14 +3738,14 @@ public function listLoginVerifiers($filter=null, $top=null, $skip=null, $orderBy 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Retrieve the list of locations for a marketplace. * * Retrieves the list of suggested locations for a marketplace. - * + * Swagger Name: AvaTaxClient * * @param string $marketplaceId MarketplaceId of a marketplace * @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. @@ -3730,7 +3759,7 @@ public function listMarketplaceLocations($marketplaceId, $top=null, $skip=null, 'query' => ['marketplaceId' => $marketplaceId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3739,7 +3768,7 @@ public function listMarketplaceLocations($marketplaceId, $top=null, $skip=null, * Returns the full list of all Avalara-supported nexus for all countries and regions. * * This API is intended to be useful if your user interface needs to display a selectable list of nexus. - * + * 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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus * @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. @@ -3753,7 +3782,7 @@ public function listNexus($filter=null, $top=null, $skip=null, $orderBy=null) 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3764,7 +3793,7 @@ public function listNexus($filter=null, $top=null, $skip=null, $orderBy=null) * In general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address * where the company does business. * The results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address. - * + * Swagger Name: AvaTaxClient * * @param string $line1 The first address line portion of this address. * @param string $line2 The first address line portion of this address. @@ -3785,7 +3814,7 @@ public function listNexusByAddress($line1, $line2, $line3, $city, $region, $post 'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3794,7 +3823,7 @@ public function listNexusByAddress($line1, $line2, $line3, $city, $region, $post * Returns all Avalara-supported nexus for the specified country. * * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country. - * + * Swagger Name: AvaTaxClient * * @param string $country The country in which you want to fetch the system nexus * @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus @@ -3809,7 +3838,7 @@ public function listNexusByCountry($country, $filter=null, $top=null, $skip=null 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3818,7 +3847,7 @@ public function listNexusByCountry($country, $filter=null, $top=null, $skip=null * Returns all Avalara-supported nexus for the specified country and region. * * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region. - * + * 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. @@ -3834,7 +3863,7 @@ public function listNexusByCountryAndRegion($country, $region, $filter=null, $to 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3855,7 +3884,7 @@ public function listNexusByCountryAndRegion($country, $region, $filter=null, $to * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param string $formCode The form code that we are looking up the nexus for * @return NexusByTaxFormModel @@ -3866,7 +3895,7 @@ public function listNexusByFormCode($formCode) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3875,7 +3904,7 @@ public function listNexusByFormCode($formCode) { * Returns all Avalara-supported nexus for the specified specified tax type group. * * This API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group. - * + * Swagger Name: AvaTaxClient * * @param string $taxTypeGroup The tax type group to fetch the supporting system nexus for. * @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus @@ -3890,7 +3919,7 @@ public function listNexusByTaxTypeGroup($taxTypeGroup, $filter=null, $top=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3898,7 +3927,7 @@ public function listNexusByTaxTypeGroup($taxTypeGroup, $filter=null, $top=null, * * Returns the full list of Avalara-supported nexus tax type groups * This API is intended to be useful to identify all the different tax sub-types. - * + * 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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn * @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. @@ -3912,7 +3941,7 @@ public function listNexusTaxTypeGroups($filter=null, $top=null, $skip=null, $ord 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3920,7 +3949,7 @@ public function listNexusTaxTypeGroups($filter=null, $top=null, $skip=null, $ord * * Returns the full list of Avalara-supported tax notice customer funding options. * This API is intended to be useful to identify all the different notice customer funding options that can be used in notices. - * + * 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:* activeFlag, sortOrder * @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. @@ -3934,7 +3963,7 @@ public function listNoticeCustomerFundingOptions($filter=null, $top=null, $skip= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3942,7 +3971,7 @@ public function listNoticeCustomerFundingOptions($filter=null, $top=null, $skip= * * Returns the full list of Avalara-supported tax notice customer types. * This API is intended to be useful to identify all the different notice customer types. - * + * 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:* activeFlag, sortOrder * @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. @@ -3956,7 +3985,7 @@ public function listNoticeCustomerTypes($filter=null, $top=null, $skip=null, $or 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3964,7 +3993,7 @@ public function listNoticeCustomerTypes($filter=null, $top=null, $skip=null, $or * * Returns the full list of Avalara-supported tax notice filing types. * This API is intended to be useful to identify all the different notice filing types that can be used in notices. - * + * 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:* description, activeFlag, sortOrder * @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. @@ -3978,7 +4007,7 @@ public function listNoticeFilingtypes($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -3986,7 +4015,7 @@ public function listNoticeFilingtypes($filter=null, $top=null, $skip=null, $orde * * Returns the full list of Avalara-supported tax notice priorities. * This API is intended to be useful to identify all the different notice priorities that can be used in notices. - * + * 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:* activeFlag, sortOrder * @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. @@ -4000,7 +4029,7 @@ public function listNoticePriorities($filter=null, $top=null, $skip=null, $order 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4008,7 +4037,7 @@ public function listNoticePriorities($filter=null, $top=null, $skip=null, $order * * Returns the full list of Avalara-supported tax notice reasons. * This API is intended to be useful to identify all the different tax notice reasons. - * + * 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:* description, activeFlag, sortOrder * @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. @@ -4022,7 +4051,7 @@ public function listNoticeReasons($filter=null, $top=null, $skip=null, $orderBy= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4030,7 +4059,7 @@ public function listNoticeReasons($filter=null, $top=null, $skip=null, $orderBy= * * Returns the full list of Avalara-supported tax notice responsibility ids * This API is intended to be useful to identify all the different tax notice responsibilities. - * + * 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:* sortOrder * @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. @@ -4044,7 +4073,7 @@ public function listNoticeResponsibilities($filter=null, $top=null, $skip=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4052,7 +4081,7 @@ public function listNoticeResponsibilities($filter=null, $top=null, $skip=null, * * Returns the full list of Avalara-supported tax notice root causes * This API is intended to be useful to identify all the different tax notice root causes. - * + * 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:* sortOrder * @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. @@ -4066,7 +4095,7 @@ public function listNoticeRootCauses($filter=null, $top=null, $skip=null, $order 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4074,7 +4103,7 @@ public function listNoticeRootCauses($filter=null, $top=null, $skip=null, $order * * Returns the full list of Avalara-supported tax notice statuses. * This API is intended to be useful to identify all the different tax notice statuses. - * + * 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:* isOpen, sortOrder * @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. @@ -4088,7 +4117,7 @@ public function listNoticeStatuses($filter=null, $top=null, $skip=null, $orderBy 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4096,7 +4125,7 @@ public function listNoticeStatuses($filter=null, $top=null, $skip=null, $orderBy * * Returns the full list of Avalara-supported tax notice types. * This API is intended to be useful to identify all the different notice types that can be used in notices. - * + * 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:* activeFlag, sortOrder * @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. @@ -4110,7 +4139,7 @@ public function listNoticeTypes($filter=null, $top=null, $skip=null, $orderBy=nu 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4119,7 +4148,7 @@ public function listNoticeTypes($filter=null, $top=null, $skip=null, $orderBy=nu * Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call. * This list of parameters is available for use when configuring your transaction. * Some parameters are only available for use if you have subscribed to certain features of AvaTax. - * + * 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:* serviceTypes, regularExpression, 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. @@ -4133,7 +4162,7 @@ public function listParameters($filter=null, $top=null, $skip=null, $orderBy=nul 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4153,7 +4182,7 @@ public function listParameters($filter=null, $top=null, $skip=null, $orderBy=nul * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode Company code. * @param string $itemCode Item code. @@ -4169,7 +4198,7 @@ public function listParametersByItem($companyCode, $itemCode, $filter=null, $top 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4178,7 +4207,7 @@ public function listParametersByItem($companyCode, $itemCode, $filter=null, $top * Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call. * This list of parameters is available for use when configuring your transaction. * Some parameters are only available for use if you have subscribed to certain features of AvaTax. - * + * 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:* 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. @@ -4192,7 +4221,7 @@ public function listParametersUsage($filter=null, $top=null, $skip=null, $orderB 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4200,7 +4229,7 @@ public function listParametersUsage($filter=null, $top=null, $skip=null, $orderB * * Returns the full list of Avalara-supported permission types. * This API is intended to be useful to identify the capabilities of a particular user logon. - * + * Swagger Name: AvaTaxClient * * @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. @@ -4212,14 +4241,14 @@ public function listPermissions($top=null, $skip=null) { 'query' => ['$top' => $top, '$skip' => $skip], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Retrieve the full list of Avalara-supported postal codes. * * Retrieves the list of Avalara-supported postal codes. - * + * 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/). * @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. @@ -4233,7 +4262,7 @@ public function listPostalCodes($filter=null, $top=null, $skip=null, $orderBy=nu 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4248,7 +4277,7 @@ public function listPostalCodes($filter=null, $top=null, $skip=null, $orderBy=nu * To select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your * preferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of * the program. - * + * 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:* effectiveDate, endDate * @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. @@ -4262,7 +4291,7 @@ public function listPreferredPrograms($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4272,7 +4301,7 @@ public function listPreferredPrograms($filter=null, $top=null, $skip=null, $orde * * Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. * More than one tax authority might use the same product classification system, but they might charge different tax rates for products. - * + * 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:* countries * @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. @@ -4287,7 +4316,7 @@ public function listProductClassificationSystems($filter=null, $top=null, $skip= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4305,7 +4334,7 @@ public function listProductClassificationSystems($filter=null, $top=null, $skip= * * Replace '?' with '\_-ava3f-\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code' * * Replace '%' with '\_-ava25-\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code' * * Replace '#' with '\_-ava23-\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code' - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code. * @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:* countries @@ -4321,7 +4350,7 @@ public function listProductClassificationSystemsByCompany($companyCode, $filter= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4329,7 +4358,7 @@ public function listProductClassificationSystemsByCompany($companyCode, $filter= * * Returns the full list of Avalara-supported rate type file types * This API is intended to be useful to identify all the different rate types. - * + * Swagger Name: AvaTaxClient * * @param string $country The country to examine for rate types * @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/). @@ -4344,7 +4373,7 @@ public function listRateTypesByCountry($country, $filter=null, $top=null, $skip= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4352,7 +4381,7 @@ public function listRateTypesByCountry($country, $filter=null, $top=null, $skip= * * Returns the list of Avalara-supported rate type file types * This API is intended to be useful to identify all the different rate types. - * + * Swagger Name: AvaTaxClient * * @param string $country The country to examine for rate types * @param string $taxTypeId The taxType for the country to examine for rate types @@ -4369,7 +4398,7 @@ public function listRateTypesByCountryTaxTypeTaxSubType($country, $taxTypeId, $t 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4378,7 +4407,7 @@ public function listRateTypesByCountryTaxTypeTaxSubType($country, $taxTypeId, $t * Returns a list of all ISO 3166 region codes and their US English friendly names. * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region * within the country for a shipping addresses. - * + * 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:* localizedNames * @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. @@ -4392,7 +4421,7 @@ public function listRegions($filter=null, $top=null, $skip=null, $orderBy=null) 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4401,7 +4430,7 @@ public function listRegions($filter=null, $top=null, $skip=null, $orderBy=null) * Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names. * This API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region * within the country for a shipping addresses. - * + * Swagger Name: AvaTaxClient * * @param string $country The country of which you want to fetch ISO 3166 regions * @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:* localizedNames @@ -4416,7 +4445,7 @@ public function listRegionsByCountry($country, $filter=null, $top=null, $skip=nu 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4424,7 +4453,7 @@ public function listRegionsByCountry($country, $filter=null, $top=null, $skip=nu * * Returns the full list of Avalara-supported resource file types * This API is intended to be useful to identify all the different resource file types. - * + * 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/). * @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. @@ -4438,7 +4467,7 @@ public function listResourceFileTypes($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4447,7 +4476,7 @@ public function listResourceFileTypes($filter=null, $top=null, $skip=null, $orde * Returns the full list of Avalara-supported usage of extra parameters for the returns. * This list of parameters is available for use with Returns. * Some parameters are only available for use if you have subscribed to certain features of AvaTax. - * + * 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:* 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. @@ -4461,7 +4490,7 @@ public function listReturnsParametersUsage($filter=null, $top=null, $skip=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4470,7 +4499,7 @@ public function listReturnsParametersUsage($filter=null, $top=null, $skip=null, * Returns the full list of Avalara-supported permission types. * This API is intended to be useful when designing a user interface for selecting the security role of a user account. * Some security roles are restricted for Avalara internal use. - * + * 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/). * @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. @@ -4484,7 +4513,7 @@ public function listSecurityRoles($filter=null, $top=null, $skip=null, $orderBy= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4494,7 +4523,7 @@ public function listSecurityRoles($filter=null, $top=null, $skip=null, $orderBy= * This API is intended to be useful for identifying which features you have added to your account. * You may always contact Avalara's sales department for information on available products or services. * You cannot change your subscriptions directly through the 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/). * @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. @@ -4508,14 +4537,14 @@ public function listSubscriptionTypes($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Retrieve the list all tags supported by avalara * * Retrieves the list of suggested locations for a marketplace. - * + * 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/). * @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. @@ -4529,7 +4558,7 @@ public function listTags($filter=null, $top=null, $skip=null, $orderBy=null) 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4537,7 +4566,7 @@ public function listTags($filter=null, $top=null, $skip=null, $orderBy=null) * * Returns the full list of Avalara-supported tax authorities. * This API is intended to be useful to identify all the different authorities that receive tax. - * + * 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/). * @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. @@ -4551,7 +4580,7 @@ public function listTaxAuthorities($filter=null, $top=null, $skip=null, $orderBy 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4561,7 +4590,7 @@ public function listTaxAuthorities($filter=null, $top=null, $skip=null, $orderBy * This list represents tax forms that Avalara recognizes. * Customers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically * based on the customer's AvaTax data. - * + * 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/). * @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. @@ -4575,7 +4604,7 @@ public function listTaxAuthorityForms($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4583,7 +4612,7 @@ public function listTaxAuthorityForms($filter=null, $top=null, $skip=null, $orde * * Returns the full list of Avalara-supported tax authority types. * This API is intended to be useful to identify all the different authority types. - * + * 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/). * @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. @@ -4597,7 +4626,7 @@ public function listTaxAuthorityTypes($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4612,7 +4641,7 @@ public function listTaxAuthorityTypes($filter=null, $top=null, $skip=null, $orde * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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/). * @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. @@ -4626,7 +4655,7 @@ public function listTaxCodes($filter=null, $top=null, $skip=null, $orderBy=null) 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4635,7 +4664,7 @@ public function listTaxCodes($filter=null, $top=null, $skip=null, $orderBy=null) * Returns the full list of recognized tax code types. * A 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode. * This API is intended to be useful for broadly searching for tax codes by tax code type. - * + * Swagger Name: AvaTaxClient * * @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. @@ -4647,7 +4676,7 @@ public function listTaxCodeTypes($top=null, $skip=null) { 'query' => ['$top' => $top, '$skip' => $skip], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4655,7 +4684,7 @@ public function listTaxCodeTypes($top=null, $skip=null) { * * Returns the full list of Avalara-supported Tax Forms * This API is intended to be useful to identify all the different Tax Forms - * + * 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/). * @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. @@ -4669,7 +4698,7 @@ public function listTaxForms($filter=null, $top=null, $skip=null, $orderBy=null) 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4677,7 +4706,7 @@ public function listTaxForms($filter=null, $top=null, $skip=null, $orderBy=null) * * Returns the full list of Avalara-supported tax sub-types * This API is intended to be useful to identify all the different tax sub-types. - * + * 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/). * @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. @@ -4691,7 +4720,7 @@ public function listTaxSubTypes($filter=null, $top=null, $skip=null, $orderBy=nu 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4699,7 +4728,7 @@ public function listTaxSubTypes($filter=null, $top=null, $skip=null, $orderBy=nu * * Returns the full list of Avalara-supported tax sub-types * This API is intended to be useful to identify all the different tax sub-types for given country and TaxType. - * + * Swagger Name: AvaTaxClient * * @param string $country The country to examine for taxsubtype * @param string $taxTypeId The taxType for the country to examine for taxsubtype @@ -4715,7 +4744,7 @@ public function listTaxSubTypesByCountryAndTaxType($country, $taxTypeId, $filter 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4723,7 +4752,7 @@ public function listTaxSubTypesByCountryAndTaxType($country, $taxTypeId, $filter * * Returns the full list of Avalara-supported tax sub-types by jurisdiction and region * This API is intended to be useful to identify all the different tax sub-types. - * + * Swagger Name: AvaTaxClient * * @param string $jurisdictionCode The jurisdiction code of the tax sub type. * @param string $region The region of the tax sub type. @@ -4739,7 +4768,7 @@ public function listTaxSubTypesByJurisdictionAndRegion($jurisdictionCode, $regio 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4747,7 +4776,7 @@ public function listTaxSubTypesByJurisdictionAndRegion($jurisdictionCode, $regio * * Returns the full list of Avalara-supported tax type groups * This API is intended to be useful to identify all the different tax type groups. - * + * 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:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence * @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. @@ -4761,14 +4790,14 @@ public function listTaxTypeGroups($filter=null, $top=null, $skip=null, $orderBy= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Retrieve the list of applicable TaxTypes * * Retrieves the list of applicable TaxTypes based on Nexus of the company. - * + * Swagger Name: AvaTaxClient * * @param string $country The country for which you want to retrieve the unitofbasis information * @param int $companyId Your companyId to retrieve the applicable taxtypes @@ -4783,14 +4812,14 @@ public function listTaxTypesByNexusAndCountry($country, $companyId, $top=null, $ 'query' => ['companyId' => $companyId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** * Retrieve the list of applicable UnitOfBasis * * Retrieves the list of applicable UnitOfBasis - * + * Swagger Name: AvaTaxClient * * @param string $country The country for which you want to retrieve the unitofbasis information * @param string $taxTypeId The taxtype for which you want to retrieve the unitofbasis information @@ -4807,7 +4836,7 @@ public function listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType($coun 'query' => ['rateTypeId' => $rateTypeId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4816,7 +4845,7 @@ public function listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType($coun * List all units of measurement systems defined by Avalara. * * A unit of measurement system is a method of measuring a quantity, such as distance, mass, or others. - * + * 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:* id * @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. @@ -4830,7 +4859,7 @@ public function listUnitOfMeasurement($filter=null, $top=null, $skip=null, $orde 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4845,7 +4874,7 @@ public function listUnitOfMeasurement($filter=null, $top=null, $skip=null, $orde * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that owns this DistanceThreshold * @param CompanyDistanceThresholdModel[] $model The DistanceThreshold object or objects you wish to create. @@ -4857,7 +4886,7 @@ public function createDistanceThreshold($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -4872,7 +4901,7 @@ public function createDistanceThreshold($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that owns this DistanceThreshold * @param int $id The unique ID number of the DistanceThreshold object you wish to delete. @@ -4884,7 +4913,7 @@ public function deleteDistanceThreshold($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -4899,7 +4928,7 @@ public function deleteDistanceThreshold($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this DistanceThreshold object * @param int $id The unique ID number referring to this DistanceThreshold object @@ -4911,7 +4940,7 @@ public function getDistanceThreshold($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4926,7 +4955,7 @@ public function getDistanceThreshold($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company whose DistanceThreshold objects you wish to list. * @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/). @@ -4942,7 +4971,7 @@ public function listDistanceThresholds($companyId, $filter=null, $include=null, 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4960,7 +4989,7 @@ public function listDistanceThresholds($companyId, $filter=null, $include=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * 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/). * @param string $include A comma separated list of additional data to retrieve. @@ -4975,7 +5004,7 @@ public function queryDistanceThresholds($filter=null, $include=null, $top=null, 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -4993,7 +5022,7 @@ public function queryDistanceThresholds($filter=null, $include=null, $top=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company that owns this DistanceThreshold object. * @param int $id The unique ID number of the DistanceThreshold object to replace. @@ -5006,7 +5035,7 @@ public function updateDistanceThreshold($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -5019,7 +5048,7 @@ public function updateDistanceThreshold($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company ID that will be issued this certificate. * @param CreateECommerceTokenInputModel $model @@ -5031,7 +5060,7 @@ public function createECommerceToken($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5044,7 +5073,7 @@ public function createECommerceToken($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company ID that the refreshed certificate belongs to. * @param RefreshECommerceTokenInputModel $model @@ -5056,7 +5085,7 @@ public function refreshECommerceToken($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -5070,7 +5099,7 @@ public function refreshECommerceToken($companyId, $model) { * * * This API requires openId bearer token for authentication * * 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 int $companyId The unique ID of the company that owns the filing calendar object * @param CycleSafeEditRequestModel $model Cycle Safe Options Request @@ -5082,7 +5111,7 @@ public function cycleSafeOptions($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5094,7 +5123,7 @@ public function cycleSafeOptions($companyId, $model) { * * * This API requires openId bearer token for authentication * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID of the company * @param int $filingCalendarId The unique ID of the filing calendar that will remove setting @@ -5107,7 +5136,7 @@ public function deleteCompanyReturnSettings($companyId, $filingCalendarId, $comp 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5119,10 +5148,10 @@ public function deleteCompanyReturnSettings($companyId, $filingCalendarId, $comp * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * 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 int $companyId The ID of the company that owns these batches - * @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:* taxAuthorityId, taxAuthorityName, taxAuthorityType, settings + * @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:* taxTypes, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings * @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`. @@ -5136,7 +5165,7 @@ public function legacyFilingCalendars($companyId, $filter=null, $top=null, $skip 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, 'returnCountry' => $returnCountry, 'returnRegion' => $returnRegion], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5146,7 +5175,7 @@ public function legacyFilingCalendars($companyId, $filter=null, $top=null, $skip * * * This API requires openId bearer token for authentication * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these returns * @param int $filingReturnId The ID of the filing return @@ -5158,7 +5187,7 @@ public function getAccrualFilings($companyId, $filingReturnId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5170,7 +5199,7 @@ public function getAccrualFilings($companyId, $filingReturnId) { * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * This API is available by invitation only.*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin. * * 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 int $companyId The ID of the company that owns these batches * @param int $endPeriodMonth The month of the period you are trying to retrieve @@ -5189,7 +5218,7 @@ public function getFiledReturns($companyId, $endPeriodMonth, $endPeriodYear, $fr 'query' => ['endPeriodMonth' => $endPeriodMonth, 'endPeriodYear' => $endPeriodYear, 'frequency' => $frequency, 'status' => $status, 'country' => $country, 'region' => $region, 'filingCalendarId' => $filingCalendarId, 'taxformCode' => $taxformCode], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5200,7 +5229,7 @@ public function getFiledReturns($companyId, $endPeriodMonth, $endPeriodYear, $fr * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return FirmClientLinkageOutputModel @@ -5211,7 +5240,7 @@ public function approveFirmClientLinkage($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5231,7 +5260,7 @@ public function approveFirmClientLinkage($id) { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. - * + * Swagger Name: AvaTaxClient * * @param NewFirmClientAccountRequestModel $model Information about the account you wish to create. * @return FirmClientLinkageOutputModel @@ -5242,7 +5271,7 @@ public function createAndLinkNewFirmClientAccount($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5253,7 +5282,7 @@ public function createAndLinkNewFirmClientAccount($model) { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param FirmClientLinkageInputModel $model FirmClientLinkageInputModel * @return FirmClientLinkageOutputModel @@ -5264,7 +5293,7 @@ public function createFirmClientLinkage($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5275,7 +5304,7 @@ public function createFirmClientLinkage($model) { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return ErrorDetail[] @@ -5286,7 +5315,7 @@ public function deleteFirmClientLinkage($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5297,7 +5326,7 @@ public function deleteFirmClientLinkage($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return FirmClientLinkageOutputModel @@ -5308,7 +5337,7 @@ public function getFirmClientLinkage($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5319,7 +5348,7 @@ public function getFirmClientLinkage($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * 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:* firmAccountName, clientAccountName * @return FetchResult @@ -5330,7 +5359,7 @@ public function listFirmClientLinkage($filter=null) { 'query' => ['$filter' => $filter], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5341,7 +5370,7 @@ public function listFirmClientLinkage($filter=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return FirmClientLinkageOutputModel @@ -5352,7 +5381,7 @@ public function rejectFirmClientLinkage($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5363,7 +5392,7 @@ public function rejectFirmClientLinkage($id) { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return FirmClientLinkageOutputModel @@ -5374,7 +5403,7 @@ public function resetFirmClientLinkage($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5385,7 +5414,7 @@ public function resetFirmClientLinkage($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id * @return FirmClientLinkageOutputModel @@ -5396,7 +5425,7 @@ public function revokeFirmClientLinkage($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5416,7 +5445,7 @@ public function revokeFirmClientLinkage($id) { * ### 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 NewAccountModel @@ -5427,7 +5456,7 @@ public function requestFreeTrial($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5450,7 +5479,7 @@ public function requestFreeTrial($model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * 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 int $id The unique ID number of this funding request * @return FundingStatusModel @@ -5461,7 +5490,7 @@ public function activateFundingRequest($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5482,7 +5511,7 @@ public function activateFundingRequest($id) { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * 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 int $id The unique ID number of this funding request * @return FundingStatusModel @@ -5493,7 +5522,7 @@ public function fundingRequestStatus($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5508,7 +5537,7 @@ public function fundingRequestStatus($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item. * @param int $itemId The ID of the item you wish to delete the classifications. @@ -5520,7 +5549,7 @@ public function batchDeleteItemClassifications($companyId, $itemId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5537,7 +5566,7 @@ public function batchDeleteItemClassifications($companyId, $itemId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item. * @param int $itemId The ID of the item you wish to delete the parameters. @@ -5549,7 +5578,7 @@ public function batchDeleteItemParameters($companyId, $itemId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5568,7 +5597,7 @@ public function batchDeleteItemParameters($companyId, $itemId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this items. * @param ItemBulkUploadInputModel $model The items you wish to upload. @@ -5580,7 +5609,7 @@ public function bulkUploadItems($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5597,7 +5626,7 @@ public function bulkUploadItems($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. @@ -5610,7 +5639,7 @@ public function createItemClassifications($companyId, $itemId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5631,7 +5660,7 @@ public function createItemClassifications($companyId, $itemId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item parameter. * @param int $itemId The item id. @@ -5644,7 +5673,7 @@ public function createItemParameters($companyId, $itemId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5663,7 +5692,7 @@ public function createItemParameters($companyId, $itemId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item. * @param ItemModel[] $model The item you wish to create. @@ -5675,7 +5704,7 @@ public function createItems($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5688,7 +5717,7 @@ public function createItems($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that defined these items * @param int $itemId The ID of the item as defined by the company that owns this tag. @@ -5701,7 +5730,7 @@ public function createItemTags($companyId, $itemId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -5720,7 +5749,7 @@ public function createItemTags($companyId, $itemId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item. * @param int $id The ID of the item you wish to delete. @@ -5732,7 +5761,7 @@ public function deleteItem($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5747,7 +5776,7 @@ public function deleteItem($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. @@ -5760,7 +5789,7 @@ public function deleteItemClassification($companyId, $itemId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5777,7 +5806,7 @@ public function deleteItemClassification($companyId, $itemId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $itemId The item id @@ -5790,7 +5819,7 @@ public function deleteItemParameter($companyId, $itemId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5803,7 +5832,7 @@ public function deleteItemParameter($companyId, $itemId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that defined these items * @param int $itemId The ID of the item as defined by the company that owns this tag. @@ -5816,7 +5845,7 @@ public function deleteItemTag($companyId, $itemId, $itemTagDetailId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5829,7 +5858,7 @@ public function deleteItemTag($companyId, $itemId, $itemTagDetailId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that defined these items. * @param int $itemId The ID of the item as defined by the company that owns this tag. @@ -5841,7 +5870,7 @@ public function deleteItemTags($companyId, $itemId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -5858,7 +5887,7 @@ public function deleteItemTags($companyId, $itemId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item object * @param int $id The primary key of this item @@ -5871,7 +5900,7 @@ public function getItem($companyId, $id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5886,7 +5915,7 @@ public function getItem($companyId, $id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. @@ -5899,7 +5928,7 @@ public function getItemClassification($companyId, $itemId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5916,7 +5945,7 @@ public function getItemClassification($companyId, $itemId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $itemId The item id @@ -5929,7 +5958,7 @@ public function getItemParameter($companyId, $itemId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5942,7 +5971,7 @@ public function getItemParameter($companyId, $itemId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that defined these items * @param int $itemId The ID of the item as defined by the company that owns this tag. @@ -5957,7 +5986,7 @@ public function getItemTags($companyId, $itemId, $filter=null, $top=null, $skip= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -5975,7 +6004,7 @@ public function getItemTags($companyId, $itemId, $filter=null, $top=null, $skip= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. @@ -5991,7 +6020,7 @@ public function listItemClassifications($companyId, $itemId, $filter=null, $top= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6011,7 +6040,7 @@ public function listItemClassifications($companyId, $itemId, $filter=null, $top= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $itemId The item id @@ -6027,7 +6056,7 @@ public function listItemParameters($companyId, $itemId, $filter=null, $top=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6056,7 +6085,7 @@ public function listItemParameters($companyId, $itemId, $filter=null, $top=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that defined these items * @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:* taxCode, classifications, parameters, tags @@ -6073,7 +6102,7 @@ public function listItemsByCompany($companyId, $filter=null, $include=null, $top 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, 'tagName' => $tagName], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6094,7 +6123,7 @@ public function listItemsByCompany($companyId, $filter=null, $include=null, $top * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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:* taxCode, classifications, parameters, tags * @param string $include A comma separated list of additional data to retrieve. @@ -6109,7 +6138,7 @@ public function queryItems($filter=null, $include=null, $top=null, $skip=null, $ 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6130,7 +6159,7 @@ public function queryItems($filter=null, $include=null, $top=null, $skip=null, $ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that defined these items. * @param string $tag The master tag to be associated with item. @@ -6147,7 +6176,7 @@ public function queryItemsByTag($companyId, $tag, $filter=null, $include=null, $ 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6169,7 +6198,7 @@ public function queryItemsByTag($companyId, $tag, $filter=null, $include=null, $ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item. * @param SyncItemsRequestModel $model The request object. @@ -6181,7 +6210,7 @@ public function syncItems($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -6203,7 +6232,7 @@ public function syncItems($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this item belongs to. * @param int $id The ID of the item you wish to update @@ -6216,7 +6245,7 @@ public function updateItem($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -6233,7 +6262,7 @@ public function updateItem($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. @@ -6247,7 +6276,7 @@ public function updateItemClassification($companyId, $itemId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -6264,7 +6293,7 @@ public function updateItemClassification($companyId, $itemId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id @@ -6278,7 +6307,7 @@ public function updateItemParameter($companyId, $itemId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -6294,7 +6323,7 @@ public function updateItemParameter($companyId, $itemId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns this override * @param JurisdictionOverrideModel[] $model The jurisdiction override objects to create @@ -6306,7 +6335,7 @@ public function createJurisdictionOverrides($accountId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -6317,7 +6346,7 @@ public function createJurisdictionOverrides($accountId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns this override * @param int $id The ID of the override you wish to delete @@ -6329,7 +6358,7 @@ public function deleteJurisdictionOverride($accountId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -6345,7 +6374,7 @@ public function deleteJurisdictionOverride($accountId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns this override * @param int $id The primary key of this override @@ -6357,7 +6386,7 @@ public function getJurisdictionOverride($accountId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6376,7 +6405,7 @@ public function getJurisdictionOverride($accountId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns this override * @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:* country, Jurisdictions @@ -6392,7 +6421,7 @@ public function listJurisdictionOverridesByAccount($accountId, $filter=null, $in 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6411,7 +6440,7 @@ public function listJurisdictionOverridesByAccount($accountId, $filter=null, $in * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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:* country, Jurisdictions * @param string $include A comma separated list of additional data to retrieve. @@ -6426,7 +6455,7 @@ public function queryJurisdictionOverrides($filter=null, $include=null, $top=nul 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6437,7 +6466,7 @@ public function queryJurisdictionOverrides($filter=null, $include=null, $top=nul * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that this jurisdictionoverride belongs to. * @param int $id The ID of the jurisdictionoverride you wish to update @@ -6450,7 +6479,7 @@ public function updateJurisdictionOverride($accountId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -6471,7 +6500,7 @@ public function updateJurisdictionOverride($accountId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this location parameter. * @param int $locationId The location id. @@ -6484,7 +6513,7 @@ public function createLocationParameters($companyId, $locationId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -6495,7 +6524,7 @@ public function createLocationParameters($companyId, $locationId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this location. * @param LocationModel[] $model The location you wish to create. @@ -6507,7 +6536,7 @@ public function createLocations($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -6518,7 +6547,7 @@ public function createLocations($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this location. * @param int $id The ID of the location you wish to delete. @@ -6530,7 +6559,7 @@ public function deleteLocation($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -6547,7 +6576,7 @@ public function deleteLocation($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $locationId The location id @@ -6560,7 +6589,7 @@ public function deleteLocationParameter($companyId, $locationId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -6580,7 +6609,7 @@ public function deleteLocationParameter($companyId, $locationId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this location * @param int $id The primary key of this location @@ -6593,7 +6622,7 @@ public function getLocation($companyId, $id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6610,7 +6639,7 @@ public function getLocation($companyId, $id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $locationId The location id @@ -6623,7 +6652,7 @@ public function getLocationParameter($companyId, $locationId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6643,7 +6672,7 @@ public function getLocationParameter($companyId, $locationId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $locationId The ID of the location @@ -6659,7 +6688,7 @@ public function listLocationParameters($companyId, $locationId, $filter=null, $t 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6681,7 +6710,7 @@ public function listLocationParameters($companyId, $locationId, $filter=null, $t * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these locations * @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:* isMarketplaceOutsideUsa, settings, parameters @@ -6697,7 +6726,7 @@ public function listLocationsByCompany($companyId, $filter=null, $include=null, 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6720,7 +6749,7 @@ public function listLocationsByCompany($companyId, $filter=null, $include=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * 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:* isMarketplaceOutsideUsa, settings, parameters * @param string $include A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings. @@ -6735,7 +6764,7 @@ public function queryLocations($filter=null, $include=null, $top=null, $skip=nul 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6748,7 +6777,7 @@ public function queryLocations($filter=null, $include=null, $top=null, $skip=nul * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this location belongs to. * @param int $id The ID of the location you wish to update @@ -6761,7 +6790,7 @@ public function updateLocation($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -6778,7 +6807,7 @@ public function updateLocation($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $locationId The location id @@ -6792,7 +6821,7 @@ public function updateLocationParameter($companyId, $locationId, $id, $model) 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -6805,7 +6834,7 @@ public function updateLocationParameter($companyId, $locationId, $id, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this location * @param int $id The primary key of this location @@ -6817,7 +6846,7 @@ public function validateLocation($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6846,7 +6875,7 @@ public function validateLocation($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param string $code The transaction code for this MultiDocument transaction * @param string $type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) @@ -6860,7 +6889,7 @@ public function adjustMultiDocumentTransaction($code, $type, $include=null, $mod 'query' => ['include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -6893,7 +6922,7 @@ public function adjustMultiDocumentTransaction($code, $type, $include=null, $mod * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param string $code The transaction code for this MultiDocument transaction * @param string $type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) @@ -6905,7 +6934,7 @@ public function auditMultiDocumentTransaction($code, $type) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -6932,7 +6961,7 @@ public function auditMultiDocumentTransaction($code, $type) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param CommitMultiDocumentModel $model The commit request you wish to execute * @return MultiDocumentModel @@ -6943,7 +6972,7 @@ public function commitMultiDocumentTransaction($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -6994,7 +7023,7 @@ public function commitMultiDocumentTransaction($model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param string $include Specifies objects to include in the response after transaction is created * @param CreateMultiDocumentModel $model the multi document transaction model @@ -7006,7 +7035,7 @@ public function createMultiDocumentTransaction($include=null, $model) { 'query' => ['$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7037,7 +7066,7 @@ public function createMultiDocumentTransaction($include=null, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param string $code The multidocument code to retrieve * @param string $type The transaction type to retrieve (See DocumentType::* for a list of allowable values) @@ -7050,7 +7079,7 @@ public function getMultiDocumentTransactionByCodeAndType($code, $type, $include= 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7090,7 +7119,7 @@ public function getMultiDocumentTransactionByCodeAndType($code, $type, $include= * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $id The unique ID number of the MultiDocument transaction to retrieve * @param string $include Specifies objects to include in the response after transaction is created @@ -7102,7 +7131,7 @@ public function getMultiDocumentTransactionById($id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7140,7 +7169,7 @@ public function getMultiDocumentTransactionById($id, $include=null) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * 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:* documents * @param string $include Specifies objects to include in the response after transaction is created @@ -7155,7 +7184,7 @@ public function listMultiDocumentTransactions($filter=null, $include=null, $top= 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7210,7 +7239,7 @@ public function listMultiDocumentTransactions($filter=null, $include=null, $top= * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param string $code The code of this MultiDocument transaction * @param string $type The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values) @@ -7224,7 +7253,7 @@ public function refundMultiDocumentTransaction($code, $type, $include=null, $mod 'query' => ['$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7249,7 +7278,7 @@ public function refundMultiDocumentTransaction($code, $type, $include=null, $mod * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param VerifyMultiDocumentModel $model Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax * @return MultiDocumentModel @@ -7260,7 +7289,7 @@ public function verifyMultiDocumentTransaction($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7288,7 +7317,7 @@ public function verifyMultiDocumentTransaction($model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param string $code The transaction code for this MultiDocument transaction * @param string $type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) @@ -7301,7 +7330,7 @@ public function voidMultiDocumentTransaction($code, $type, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7330,7 +7359,7 @@ public function voidMultiDocumentTransaction($code, $type, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this nexus. * @param NexusModel[] $model The nexus you wish to create. @@ -7342,7 +7371,7 @@ public function createNexus($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7362,7 +7391,7 @@ public function createNexus($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this nexus parameter. * @param int $nexusId The nexus id. @@ -7375,7 +7404,7 @@ public function createNexusParameters($companyId, $nexusId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7400,7 +7429,7 @@ public function createNexusParameters($companyId, $nexusId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that will own this nexus. * @param DeclareNexusByAddressModel[] $model The nexus you wish to create. @@ -7412,7 +7441,7 @@ public function declareNexusByAddress($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7430,7 +7459,7 @@ public function declareNexusByAddress($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this nexus. * @param int $id The ID of the nexus you wish to delete. @@ -7443,7 +7472,7 @@ public function deleteNexus($companyId, $id, $cascadeDelete) { 'query' => ['cascadeDelete' => $cascadeDelete], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -7459,7 +7488,7 @@ public function deleteNexus($companyId, $id, $cascadeDelete) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $nexusId The nexus id @@ -7472,7 +7501,7 @@ public function deleteNexusParameter($companyId, $nexusId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -7488,7 +7517,7 @@ public function deleteNexusParameter($companyId, $nexusId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this nexus. * @param int $nexusId The ID of the nexus you wish to delete the parameters. @@ -7500,7 +7529,7 @@ public function deleteNexusParameters($companyId, $nexusId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -7518,7 +7547,7 @@ public function deleteNexusParameters($companyId, $nexusId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this nexus object * @param int $id The primary key of this nexus @@ -7531,7 +7560,7 @@ public function getNexus($companyId, $id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7553,7 +7582,7 @@ public function getNexus($companyId, $id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this nexus object * @param string $formCode The form code that we are looking up the nexus for @@ -7566,7 +7595,7 @@ public function getNexusByFormCode($companyId, $formCode, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7582,7 +7611,7 @@ public function getNexusByFormCode($companyId, $formCode, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $nexusId The nexus id @@ -7595,7 +7624,7 @@ public function getNexusParameter($companyId, $nexusId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7616,7 +7645,7 @@ public function getNexusParameter($companyId, $nexusId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these nexus objects * @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus @@ -7632,7 +7661,7 @@ public function listNexusByCompany($companyId, $filter=null, $include=null, $top 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7653,7 +7682,7 @@ public function listNexusByCompany($companyId, $filter=null, $include=null, $top * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these nexus objects * @param string $taxTypeGroup Name of TaxTypeGroup to filter by @@ -7670,7 +7699,7 @@ public function listNexusByCompanyAndTaxTypeGroup($companyId, $taxTypeGroup, $fi 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7689,7 +7718,7 @@ public function listNexusByCompanyAndTaxTypeGroup($companyId, $taxTypeGroup, $fi * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $nexusId The nexus id @@ -7705,7 +7734,7 @@ public function listNexusParameters($companyId, $nexusId, $filter=null, $top=nul 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7726,7 +7755,7 @@ public function listNexusParameters($companyId, $nexusId, $filter=null, $top=nul * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus * @param string $include A comma separated list of additional data to retrieve. @@ -7741,7 +7770,7 @@ public function queryNexus($filter=null, $include=null, $top=null, $skip=null, $ 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7770,7 +7799,7 @@ public function queryNexus($filter=null, $include=null, $top=null, $skip=null, $ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this nexus belongs to. * @param int $id The ID of the nexus you wish to update @@ -7783,7 +7812,7 @@ public function updateNexus($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -7800,7 +7829,7 @@ public function updateNexus($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $nexusId The nexus id @@ -7814,7 +7843,7 @@ public function updateNexusParameter($companyId, $nexusId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -7826,7 +7855,7 @@ public function updateNexusParameter($companyId, $nexusId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * 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 CreateNoticeResponsibilityTypeModel $model The responsibility type to create * @return NoticeResponsibilityModel @@ -7837,7 +7866,7 @@ public function createNoticeResponsibilityType($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7849,7 +7878,7 @@ public function createNoticeResponsibilityType($model) { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * 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 CreateNoticeRootCauseTypeModel $model The root cause type to create * @return NoticeRootCauseModel @@ -7860,7 +7889,7 @@ public function createNoticeRootCauseType($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -7871,7 +7900,7 @@ public function createNoticeRootCauseType($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $responsibilityId The unique ID of the responsibility type * @return ErrorDetail[] @@ -7882,7 +7911,7 @@ public function deleteNoticeResponsibilityType($responsibilityId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -7893,7 +7922,7 @@ public function deleteNoticeResponsibilityType($responsibilityId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $rootCauseId The unique ID of the root cause type * @return ErrorDetail[] @@ -7904,7 +7933,7 @@ public function deleteNoticeRootCauseType($rootCauseId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -7928,7 +7957,7 @@ public function deleteNoticeRootCauseType($rootCauseId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The id of the notification you wish to mark as dismissed. * @return NotificationModel @@ -7939,7 +7968,7 @@ public function dismissNotification($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -7957,7 +7986,7 @@ public function dismissNotification($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The id of the notification to retrieve. * @return NotificationModel @@ -7968,7 +7997,7 @@ public function getNotification($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -7989,7 +8018,7 @@ public function getNotification($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * 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/). * @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. @@ -8003,7 +8032,7 @@ public function listNotifications($filter=null, $top=null, $skip=null, $orderBy= 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8029,7 +8058,7 @@ public function listNotifications($filter=null, $top=null, $skip=null, $orderBy= * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API is available by invitation only. * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. - * + * Swagger Name: AvaTaxClient * * @param NewAccountRequestModel $model Information about the account you wish to create and the selected product offerings. * @return NewAccountModel @@ -8040,7 +8069,7 @@ public function requestNewAccount($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8054,7 +8083,7 @@ public function requestNewAccount($model) { * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API is available by invitation only. * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount]. - * + * Swagger Name: AvaTaxClient * * @param int $id The avatax account id of the customer * @param string $offer The offer to be added to an already existing customer @@ -8066,7 +8095,7 @@ public function requestNewEntitlement($id, $offer) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8081,7 +8110,7 @@ public function requestNewEntitlement($id, $offer) { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param AccountModel $model The account you wish to create. * @return AccountModel[] @@ -8092,7 +8121,7 @@ public function createAccount($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8116,7 +8145,7 @@ public function createAccount($model) { * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - * + * Swagger Name: AvaTaxClient * * @param NotificationModel[] $model The notifications you wish to create. * @return NotificationModel[] @@ -8127,7 +8156,7 @@ public function createNotifications($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8142,7 +8171,7 @@ public function createNotifications($model) { * ### Security Policies * * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns this subscription. * @param SubscriptionModel[] $model The subscription you wish to create. @@ -8154,7 +8183,7 @@ public function createSubscriptions($accountId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8169,7 +8198,7 @@ public function createSubscriptions($accountId, $model) { * ### Security Policies * * * This API requires the user role SystemAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account you wish to delete. * @return ErrorDetail[] @@ -8180,7 +8209,7 @@ public function deleteAccount($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -8201,7 +8230,7 @@ public function deleteAccount($id) { * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - * + * Swagger Name: AvaTaxClient * * @param int $id The id of the notification you wish to delete. * @return ErrorDetail[] @@ -8212,7 +8241,7 @@ public function deleteNotification($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -8226,7 +8255,7 @@ public function deleteNotification($id) { * ### Security Policies * * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns this subscription. * @param int $id The ID of the subscription you wish to delete. @@ -8238,7 +8267,7 @@ public function deleteSubscription($accountId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -8247,7 +8276,7 @@ public function deleteSubscription($accountId, $id) { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param string $writeMode (See TssAccountMigrationId::* for a list of allowable values) * @return AccountMigrationStatusModel @@ -8258,7 +8287,7 @@ public function listAccountsByTssWriteMode($writeMode) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8275,7 +8304,7 @@ public function listAccountsByTssWriteMode($writeMode) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * This API is available to Avalara system-level (registrar-level) users only. - * + * Swagger Name: AvaTaxClient * * @param int $userId The unique ID of the user whose password will be changed * @param boolean $unmigrateFromAi If user's password was migrated to AI, undo this. @@ -8288,7 +8317,7 @@ public function resetPassword($userId, $unmigrateFromAi, $model) { 'query' => ['unmigrateFromAi' => $unmigrateFromAi], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8302,7 +8331,7 @@ public function resetPassword($userId, $unmigrateFromAi, $model) { * ### Security Policies * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account you wish to update. * @param AccountModel $model The account object you wish to update. @@ -8314,7 +8343,7 @@ public function updateAccount($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -8335,7 +8364,7 @@ public function updateAccount($id, $model) { * * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. * * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create]. - * + * Swagger Name: AvaTaxClient * * @param int $id The id of the notification you wish to update. * @param NotificationModel $model The notification object you wish to update. @@ -8347,7 +8376,7 @@ public function updateNotification($id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -8365,7 +8394,7 @@ public function updateNotification($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that this subscription belongs to. * @param int $id The ID of the subscription you wish to update @@ -8378,7 +8407,7 @@ public function updateSubscription($accountId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -8402,7 +8431,7 @@ public function updateSubscription($accountId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The unique ID number of this report * @return object @@ -8413,7 +8442,7 @@ public function downloadReport($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8430,7 +8459,7 @@ public function downloadReport($id) { * * When a report's status is `Completed`, call `DownloadReport` to retrieve the file. * * This API call returns information about any report type. - * + * Swagger Name: AvaTaxClient * * @param int $id The unique ID number of the report to retrieve * @return ReportModel @@ -8441,7 +8470,7 @@ public function getReport($id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8471,7 +8500,7 @@ public function getReport($id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The unique ID number of the company to report on. * @param ExportDocumentLineModel $model Options that may be configured to customize the report. @@ -8483,7 +8512,7 @@ public function initiateExportDocumentLineReport($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8504,7 +8533,7 @@ public function initiateExportDocumentLineReport($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The id of the company for which to get reports. * @param string $pageKey Provide a page key to retrieve the next page of results. @@ -8518,7 +8547,7 @@ public function listReports($companyId, $pageKey, $skip=null, $top=null) { 'query' => ['companyId' => $companyId, 'pageKey' => $pageKey, '$skip' => $skip, '$top' => $top], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8543,7 +8572,7 @@ public function listReports($companyId, $pageKey, $skip=null, $top=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this setting. * @param SettingModel[] $model The setting you wish to create. @@ -8555,7 +8584,7 @@ public function createSettings($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8575,7 +8604,7 @@ public function createSettings($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this setting. * @param int $id The ID of the setting you wish to delete. @@ -8587,7 +8616,7 @@ public function deleteSetting($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -8607,7 +8636,7 @@ public function deleteSetting($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this setting * @param int $id The primary key of this setting @@ -8619,7 +8648,7 @@ public function getSetting($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8642,7 +8671,7 @@ public function getSetting($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these settings * @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:* modifiedDate, ModifiedUserId @@ -8658,7 +8687,7 @@ public function listSettingsByCompany($companyId, $filter=null, $include=null, $ 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8681,7 +8710,7 @@ public function listSettingsByCompany($companyId, $filter=null, $include=null, $ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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:* modifiedDate, ModifiedUserId * @param string $include A comma separated list of additional data to retrieve. @@ -8696,7 +8725,7 @@ public function querySettings($filter=null, $include=null, $top=null, $skip=null 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8720,7 +8749,7 @@ public function querySettings($filter=null, $include=null, $top=null, $skip=null * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this setting belongs to. * @param int $id The ID of the setting you wish to update @@ -8733,7 +8762,7 @@ public function updateSetting($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -8746,7 +8775,7 @@ public function updateSetting($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns this subscription * @param int $id The primary key of this subscription @@ -8758,7 +8787,7 @@ public function getSubscription($accountId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8774,7 +8803,7 @@ public function getSubscription($accountId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account that owns these subscriptions * @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:* subscriptionDescription @@ -8789,7 +8818,7 @@ public function listSubscriptionsByAccount($accountId, $filter=null, $top=null, 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8805,7 +8834,7 @@ public function listSubscriptionsByAccount($accountId, $filter=null, $top=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * 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:* subscriptionDescription * @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. @@ -8819,7 +8848,7 @@ public function querySubscriptions($filter=null, $top=null, $skip=null, $orderBy 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8834,7 +8863,7 @@ public function querySubscriptions($filter=null, $top=null, $skip=null, $orderBy * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this tax code. * @param TaxCodeModel[] $model The tax code you wish to create. @@ -8846,7 +8875,7 @@ public function createTaxCodes($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -8857,7 +8886,7 @@ public function createTaxCodes($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this tax code. * @param int $id The ID of the tax code you wish to delete. @@ -8869,7 +8898,7 @@ public function deleteTaxCode($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -8884,7 +8913,7 @@ public function deleteTaxCode($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this tax code * @param int $id The primary key of this tax code @@ -8896,7 +8925,7 @@ public function getTaxCode($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8914,7 +8943,7 @@ public function getTaxCode($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these tax codes * @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/). @@ -8930,7 +8959,7 @@ public function listTaxCodesByCompany($companyId, $filter=null, $include=null, $ 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8948,7 +8977,7 @@ public function listTaxCodesByCompany($companyId, $filter=null, $include=null, $ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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/). * @param string $include A comma separated list of additional data to retrieve. @@ -8963,7 +8992,7 @@ public function queryTaxCodes($filter=null, $include=null, $top=null, $skip=null 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -8980,7 +9009,7 @@ public function queryTaxCodes($filter=null, $include=null, $top=null, $skip=null * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this tax code belongs to. * @param int $id The ID of the tax code you wish to update @@ -8993,7 +9022,7 @@ public function updateTaxCode($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -9027,7 +9056,7 @@ public function updateTaxCode($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param PointOfSaleDataRequestModel $model Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include. * @return object @@ -9038,7 +9067,7 @@ public function buildTaxContentFile($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9072,7 +9101,7 @@ public function buildTaxContentFile($model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID number of the company that owns this location. * @param int $id The ID number of the location to retrieve point-of-sale data. @@ -9088,7 +9117,7 @@ public function buildTaxContentFileForLocation($companyId, $id, $date, $format, 'query' => ['date' => $date, 'format' => $format, 'partnerId' => $partnerId, 'includeJurisCodes' => $includeJurisCodes], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9138,7 +9167,7 @@ public function buildTaxContentFileForLocation($companyId, $id, $date, $format, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param string $date The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31 * @param string $region A two character region code which limits results to a specific region. @@ -9150,7 +9179,7 @@ public function downloadTaxRatesByZipCode($date, $region) { 'query' => ['region' => $region], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9176,7 +9205,7 @@ public function downloadTaxRatesByZipCode($date, $region) { * * Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) * for information on how to upgrade to the full AvaTax CreateTransaction API. - * + * Swagger Name: AvaTaxClient * * @param string $line1 The street address of the location. * @param string $line2 The street address of the location. @@ -9193,7 +9222,7 @@ public function taxRatesByAddress($line1, $line2, $line3, $city, $region, $posta 'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9221,7 +9250,7 @@ public function taxRatesByAddress($line1, $line2, $line3, $city, $region, $posta * * Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/) * for information on how to upgrade to the full AvaTax CreateTransaction API. - * + * Swagger Name: AvaTaxClient * * @param string $country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`. * @param string $postalCode The postal code of the location. @@ -9233,7 +9262,7 @@ public function taxRatesByPostalCode($country, $postalCode) { 'query' => ['country' => $country, 'postalCode' => $postalCode], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9256,7 +9285,7 @@ public function taxRatesByPostalCode($country, $postalCode) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this tax rule. * @param TaxRuleModel[] $model The tax rule you wish to create. @@ -9268,7 +9297,7 @@ public function createTaxRules($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9291,7 +9320,7 @@ public function createTaxRules($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this tax rule. * @param int $id The ID of the tax rule you wish to delete. @@ -9303,7 +9332,7 @@ public function deleteTaxRule($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -9326,7 +9355,7 @@ public function deleteTaxRule($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this tax rule * @param int $id The primary key of this tax rule @@ -9338,7 +9367,7 @@ public function getTaxRule($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9364,7 +9393,7 @@ public function getTaxRule($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these tax rules * @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:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis @@ -9380,7 +9409,7 @@ public function listTaxRules($companyId, $filter=null, $include=null, $top=null, 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9406,7 +9435,7 @@ public function listTaxRules($companyId, $filter=null, $include=null, $top=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * + * 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:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis * @param string $include A comma separated list of additional data to retrieve. @@ -9421,7 +9450,7 @@ public function queryTaxRules($filter=null, $include=null, $top=null, $skip=null 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9444,7 +9473,7 @@ public function queryTaxRules($filter=null, $include=null, $top=null, $skip=null * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this tax rule belongs to. * @param int $id The ID of the tax rule you wish to update @@ -9457,7 +9486,7 @@ public function updateTaxRule($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -9488,7 +9517,7 @@ public function updateTaxRule($companyId, $id, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $include Specifies objects to include in the response after transaction is created * @param AddTransactionLineModel $model information about the transaction and lines to be added @@ -9500,7 +9529,7 @@ public function addLines($include=null, $model) { 'query' => ['$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9540,7 +9569,7 @@ public function addLines($include=null, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to adjust @@ -9555,7 +9584,7 @@ public function adjustTransaction($companyCode, $transactionCode, $documentType, 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9589,7 +9618,7 @@ public function adjustTransaction($companyCode, $transactionCode, $documentType, * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The code identifying the company that owns this transaction * @param string $transactionCode The code identifying the transaction @@ -9601,7 +9630,7 @@ public function auditTransaction($companyCode, $transactionCode) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9635,7 +9664,7 @@ public function auditTransaction($companyCode, $transactionCode) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The code identifying the company that owns this transaction * @param string $transactionCode The code identifying the transaction @@ -9648,7 +9677,7 @@ public function auditTransactionWithType($companyCode, $transactionCode, $docume 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -9666,7 +9695,7 @@ public function auditTransactionWithType($companyCode, $transactionCode, $docume * * * This API requires the user role Compliance Root User. * * 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 BulkLockTransactionModel $model bulk lock request * @return BulkLockTransactionResult @@ -9677,7 +9706,7 @@ public function bulkLockTransaction($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9717,7 +9746,7 @@ public function bulkLockTransaction($model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to change @@ -9732,7 +9761,7 @@ public function changeTransactionCode($companyCode, $transactionCode, $documentT 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9770,7 +9799,7 @@ public function changeTransactionCode($companyCode, $transactionCode, $documentT * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to commit @@ -9785,7 +9814,7 @@ public function commitTransaction($companyCode, $transactionCode, $documentType, 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9829,7 +9858,7 @@ public function commitTransaction($companyCode, $transactionCode, $documentType, * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $include Specifies objects to include in the response after transaction is created * @param CreateOrAdjustTransactionModel $model The transaction you wish to create or adjust @@ -9841,7 +9870,7 @@ public function createOrAdjustTransaction($include=null, $model) { 'query' => ['$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9892,7 +9921,7 @@ public function createOrAdjustTransaction($include=null, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $include Specifies objects to include in the response after transaction is created * @param CreateTransactionModel $model The transaction you wish to create @@ -9904,7 +9933,7 @@ public function createTransaction($include=null, $model) { 'query' => ['$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9932,7 +9961,7 @@ public function createTransaction($include=null, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $include Specifies objects to include in the response after transaction is created * @param RemoveTransactionLineModel $model information about the transaction and lines to be removed @@ -9944,7 +9973,7 @@ public function deleteLines($include=null, $model) { 'query' => ['$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -9981,7 +10010,7 @@ public function deleteLines($include=null, $model) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to retrieve @@ -9995,7 +10024,7 @@ public function getTransactionByCode($companyCode, $transactionCode, $documentTy 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10015,7 +10044,7 @@ public function getTransactionByCode($companyCode, $transactionCode, $documentTy * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to retrieve @@ -10029,7 +10058,7 @@ public function getTransactionByCodeAndType($companyCode, $transactionCode, $doc 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10057,7 +10086,7 @@ public function getTransactionByCodeAndType($companyCode, $transactionCode, $doc * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param int $id The unique ID number of the transaction to retrieve * @param string $include Specifies objects to include in this fetch call @@ -10069,7 +10098,7 @@ public function getTransactionById($id, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10109,7 +10138,7 @@ public function getTransactionById($id, $include=null) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param int $dataSourceId Optionally filter transactions to those from a specific data source. @@ -10126,7 +10155,7 @@ public function listTransactionsByCompany($companyCode, $dataSourceId, $include= 'query' => ['dataSourceId' => $dataSourceId, '$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10166,7 +10195,7 @@ public function listTransactionsByCompany($companyCode, $dataSourceId, $include= * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * 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 $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to lock @@ -10181,7 +10210,7 @@ public function lockTransaction($companyCode, $transactionCode, $documentType, $ 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10231,7 +10260,7 @@ public function lockTransaction($companyCode, $transactionCode, $documentType, $ * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The code of the company that made the original sale * @param string $transactionCode The transaction code of the original sale @@ -10247,7 +10276,7 @@ public function refundTransaction($companyCode, $transactionCode, $include=null, 'query' => ['$include' => $include, 'documentType' => $documentType, 'useTaxDateOverride' => $useTaxDateOverride], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10285,7 +10314,7 @@ public function refundTransaction($companyCode, $transactionCode, $include=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to settle @@ -10300,7 +10329,7 @@ public function settleTransaction($companyCode, $transactionCode, $documentType, 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10333,7 +10362,7 @@ public function settleTransaction($companyCode, $transactionCode, $documentType, * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to Uncommit @@ -10347,7 +10376,7 @@ public function uncommitTransaction($companyCode, $transactionCode, $documentTyp 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10377,7 +10406,7 @@ public function uncommitTransaction($companyCode, $transactionCode, $documentTyp * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to commit @@ -10391,7 +10420,7 @@ public function unvoidTransaction($companyCode, $transactionCode, $documentType, 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => null ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10428,7 +10457,7 @@ public function unvoidTransaction($companyCode, $transactionCode, $documentType, * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to settle @@ -10443,7 +10472,7 @@ public function verifyTransaction($companyCode, $transactionCode, $documentType, 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10482,7 +10511,7 @@ public function verifyTransaction($companyCode, $transactionCode, $documentType, * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * + * Swagger Name: AvaTaxClient * * @param string $companyCode The company code of the company that recorded this transaction * @param string $transactionCode The transaction code to void @@ -10497,7 +10526,7 @@ public function voidTransaction($companyCode, $transactionCode, $documentType, $ 'query' => ['documentType' => $documentType, '$include' => $include], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10510,7 +10539,7 @@ public function voidTransaction($companyCode, $transactionCode, $documentType, $ * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaUpc. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this UPC. * @param UPCModel[] $model The UPC you wish to create. @@ -10522,7 +10551,7 @@ public function createUPCs($companyId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10534,7 +10563,7 @@ public function createUPCs($companyId, $model) { * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaUpc. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this UPC. * @param int $id The ID of the UPC you wish to delete. @@ -10546,7 +10575,7 @@ public function deleteUPC($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -10559,7 +10588,7 @@ public function deleteUPC($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaUpc. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this UPC * @param int $id The primary key of this UPC @@ -10571,7 +10600,7 @@ public function getUPC($companyId, $id) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10587,7 +10616,7 @@ public function getUPC($companyId, $id) { * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaUpc. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns these UPCs * @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/). @@ -10603,7 +10632,7 @@ public function listUPCsByCompany($companyId, $filter=null, $include=null, $top= 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10619,7 +10648,7 @@ public function listUPCsByCompany($companyId, $filter=null, $include=null, $top= * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. * * This API depends on the following active services:*Required* (all): AvaUpc. - * + * 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/). * @param string $include A comma separated list of additional data to retrieve. @@ -10634,7 +10663,7 @@ public function queryUPCs($filter=null, $include=null, $top=null, $skip=null, $o 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10649,7 +10678,7 @@ public function queryUPCs($filter=null, $include=null, $top=null, $skip=null, $o * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. * * This API depends on the following active services:*Required* (all): AvaUpc. - * + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that this UPC belongs to. * @param int $id The ID of the UPC you wish to update @@ -10662,7 +10691,79 @@ public function updateUPC($companyId, $id, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); + } + + /** + * Delete a User Defined Field by User Defined Field id for a company. + * + * Marks the existing user defined field for a company as deleted. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + * Swagger Name: AvaTaxClient + * + * @param int $companyId The id of the company the User Defined Field belongs to. + * @param int $id The id of the User Defined Field you wish to delete. + * @return ErrorDetail[] + */ + public function deleteUserDefinedField($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/userdefinedfields/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); + } + + /** + * + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + * Swagger Name: AvaTaxClient + * + * @param int $companyId + * @param string $udfType Document or Line level UDF (See UserDefinedFieldType::* for a list of allowable values) + * @param boolean $allowDefaults If true this will add defaulted UDFs to the list that are not named yet + * @return FetchResult + */ + public function listUserDefinedFieldsByCompanyId($companyId, $udfType, $allowDefaults) { + $path = "/api/v2/companies/{$companyId}/userdefinedfields"; + $guzzleParams = [ + 'query' => ['udfType' => $udfType, 'allowDefaults' => $allowDefaults], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); + } + + /** + * Update a User Defined Field identified by id for a company + * + * Updates a User Defined Field for a company. + * + * ### Security Policies + * + * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + * Swagger Name: AvaTaxClient + * + * @param int $companyId The id of the company the user defined field belongs to. + * @param int $id + * @param CompanyUserDefinedFieldModel $model + * @return CompanyUserDefinedFieldModel + */ + public function updateUserDefinedField($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/userdefinedfields"; + $guzzleParams = [ + 'query' => ['id' => $id], + 'body' => json_encode($model) + ]; + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10679,7 +10780,7 @@ public function updateUPC($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param PasswordChangeModel $model An object containing your current password and the new password. * @return string @@ -10690,7 +10791,7 @@ public function changePassword($model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -10709,7 +10810,7 @@ public function changePassword($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The unique ID number of the account where these users will be created. * @param UserModel[] $model The user or array of users you wish to create. @@ -10721,7 +10822,7 @@ public function createUsers($accountId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'POST', $guzzleParams); + return $this->restCall($path, 'POST', $guzzleParams,'21.12.0' ); } /** @@ -10737,7 +10838,7 @@ public function createUsers($accountId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the user you wish to delete. * @param int $accountId The accountID of the user you wish to delete. @@ -10749,7 +10850,7 @@ public function deleteUser($id, $accountId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'DELETE', $guzzleParams); + return $this->restCall($path, 'DELETE', $guzzleParams,'21.12.0' ); } /** @@ -10765,7 +10866,7 @@ public function deleteUser($id, $accountId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the user to retrieve. * @param int $accountId The accountID of the user you wish to get. @@ -10778,7 +10879,7 @@ public function getUser($id, $accountId, $include=null) { 'query' => ['$include' => $include], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10803,7 +10904,7 @@ public function getUser($id, $accountId, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the user to retrieve. * @param int $accountId The accountID of the user you wish to get. @@ -10815,7 +10916,7 @@ public function getUserEntitlements($id, $accountId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10837,7 +10938,7 @@ public function getUserEntitlements($id, $accountId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $accountId The accountID of the user you wish to list. * @param string $include Optional fetch commands. @@ -10853,7 +10954,7 @@ public function listUsersByAccount($accountId, $include=null, $filter=null, $top 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10877,7 +10978,7 @@ public function listUsersByAccount($accountId, $include=null, $filter=null, $top * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param string $include Optional fetch commands. * @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:* SuppressNewUserEmail @@ -10892,7 +10993,7 @@ public function queryUsers($include=null, $filter=null, $top=null, $skip=null, $ 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10906,7 +11007,7 @@ public function queryUsers($include=null, $filter=null, $top=null, $skip=null, $ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * + * Swagger Name: AvaTaxClient * * @param int $id The ID of the user you wish to update. * @param int $accountId The accountID of the user you wish to update. @@ -10919,7 +11020,7 @@ public function updateUser($id, $accountId, $model) { 'query' => [], 'body' => json_encode($model) ]; - return $this->restCall($path, 'PUT', $guzzleParams); + return $this->restCall($path, 'PUT', $guzzleParams,'21.12.0' ); } /** @@ -10933,7 +11034,7 @@ public function updateUser($id, $accountId, $model) { * within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product * or subscription to provide useful information to the current user as to whether they are entitled to use * specific features of AvaTax. - * + * Swagger Name: AvaTaxClient * * @param string $serviceTypeId The service to check * @return SubscriptionModel @@ -10944,7 +11045,7 @@ public function getMySubscription($serviceTypeId) { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10958,7 +11059,7 @@ public function getMySubscription($serviceTypeId) { * within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product * or subscription to provide useful information to the current user as to whether they are entitled to use * specific features of AvaTax. - * + * Swagger Name: AvaTaxClient * * @return FetchResult */ @@ -10968,7 +11069,7 @@ public function listMySubscriptions() { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); } /** @@ -10994,7 +11095,7 @@ public function listMySubscriptions() { * ### Security Policies * * * This API may be called without providing authentication credentials. - * + * Swagger Name: AvaTaxClient * * @return PingResultModel */ @@ -11004,7 +11105,133 @@ public function ping() { 'query' => [], 'body' => null ]; - return $this->restCall($path, 'GET', $guzzleParams); + return $this->restCall($path, 'GET', $guzzleParams,'21.12.0' ); + } + + /** + * Determines whether an individual meets or exceeds the minimum legal drinking age. + * + * The request must meet the following criteria in order to be evaluated: + * * *firstName*, *lastName*, and *address* are required fields. + * * One of the following sets of attributes are required for the *address*: + * * *line1, city, region* + * * *line1, postalCode* + * + * Optionally, the transaction and its lines may use the following parameters: + * * A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21). + * * Beyond the required *address* fields above, a *country* field is permitted + * * The valid values for this attribute are [*US, USA*] + * + * **Security Policies** + * This API depends on the active subscription *AgeVerification* + * Swagger Name: AvaTaxBeverageClient + * + * @param string $simulatedFailureCode (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes. + * @param AgeVerifyRequest $model Information about the individual whose age is being verified. + * @return AgeVerifyResult + */ + public function verifyAge($simulatedFailureCode, $model) { + $path = "/api/v2/ageverification/verify"; + $guzzleParams = [ + 'query' => ['simulatedFailureCode' => $simulatedFailureCode], + 'body' => json_encode($model) + ]; + return $this->restCall($path, 'POST', $guzzleParams,'' ); + } + + /** + * Removes the transaction from consideration when evaluating regulations that span multiple transactions. + * + * + * Swagger Name: AvaTaxBeverageClient + * + * @param string $companyCode The company code of the company that recorded the transaction + * @param string $transactionCode The transaction code to retrieve + * @param string $documentType (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice" + * @return + */ + public function deregisterShipment($companyCode, $transactionCode, $documentType) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType], + 'body' => null + ]; + return $this->restCall($path, 'DELETE', $guzzleParams,'' ); + } + + /** + * Registers the transaction so that it may be included when evaluating regulations that span multiple transactions. + * + * + * Swagger Name: AvaTaxBeverageClient + * + * @param string $companyCode The company code of the company that recorded the transaction + * @param string $transactionCode The transaction code to retrieve + * @param string $documentType (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice" + * @return + */ + public function registerShipment($companyCode, $transactionCode, $documentType) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType], + 'body' => null + ]; + return $this->restCall($path, 'PUT', $guzzleParams,'' ); + } + + /** + * Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions. + * + * + * Swagger Name: AvaTaxBeverageClient + * + * @param string $companyCode The company code of the company that recorded the transaction + * @param string $transactionCode The transaction code to retrieve + * @param string $documentType (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice" + * @return ShippingVerifyResult + */ + public function registerShipmentIfCompliant($companyCode, $transactionCode, $documentType) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registerIfCompliant"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType], + 'body' => null + ]; + return $this->restCall($path, 'PUT', $guzzleParams,'' ); + } + + /** + * Evaluates a transaction against a set of direct-to-consumer shipping regulations. + * + * The transaction and its lines must meet the following criteria in order to be evaluated: + * * The transaction must be recorded. Using a type of *SalesInvoice* is recommended. + * * A parameter with the name *AlcoholRouteType* must be specified and the value must be one of the following: '*DTC*', '*Retailer DTC*' + * * A parameter with the name *RecipientName* must be specified and the value must be the name of the recipient. + * * Each alcohol line must include a *ContainerSize* parameter that describes the volume of a single container. Use the *unit* field to specify one of the following units: '*Litre*', '*Millilitre*', '*gallon (US fluid)*', '*quart (US fluid)*', '*ounce (fluid US customary)*' + * * Each alcohol line must include a *PackSize* parameter that describes the number of containers in a pack. Specify *Count* in the *unit* field. + * + * Optionally, the transaction and its lines may use the following parameters: + * * The *ShipDate* parameter may be used if the date of shipment is different than the date of the transaction. The value should be ISO-8601 compliant (e.g. 2020-07-21). + * * The *RecipientDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). + * * The *PurchaserDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). + * * The *SalesLocation* parameter may be used to describe whether the sale was made *OnSite* or *OffSite*. *OffSite* is the default value. + * * The *AlcoholContent* parameter may be used to describe the alcohol percentage by volume of the item. Specify *Percentage* in the *unit* field. + * + * **Security Policies** + * This API depends on all of the following active subscriptions: *AvaAlcohol, AutoAddress, AvaTaxPro* + * Swagger Name: AvaTaxBeverageClient + * + * @param string $companyCode The company code of the company that recorded the transaction + * @param string $transactionCode The transaction code to retrieve + * @param string $documentType (Optional): The document type of the transaction to operate on. If omitted, defaults to "SalesInvoice" + * @return ShippingVerifyResult + */ + public function verifyShipment($companyCode, $transactionCode, $documentType) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/verify"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams,'' ); } } diff --git a/src/Models.php b/src/Models.php index 1e11d57..4605c71 100644 --- a/src/Models.php +++ b/src/Models.php @@ -16,6 +16,7 @@ /** * Represents a service that this account has subscribed to. + * Swagger Name: AvaTaxClient */ class SubscriptionModel { @@ -62,6 +63,7 @@ class SubscriptionModel } /** * An account user who is permitted to use AvaTax. + * Swagger Name: AvaTaxClient */ class UserModel { @@ -128,6 +130,7 @@ class UserModel } /** * An AvaTax account. + * Swagger Name: AvaTaxClient */ class AccountModel { @@ -190,6 +193,7 @@ class AccountModel } /** * + * Swagger Name: AvaTaxClient */ class ErrorDetail { @@ -232,6 +236,7 @@ class ErrorDetail } /** * An AvaTax account. + * Swagger Name: AvaTaxClient */ class AccountMigrationStatusModel { @@ -258,6 +263,7 @@ class AccountMigrationStatusModel } /** * Company Address Information + * Swagger Name: AvaTaxClient */ class CompanyAddress { @@ -285,6 +291,7 @@ class CompanyAddress /** * Represents a request for a new account with Avalara for a new subscriber. * Contains information about the account requested and the rate plan selected. + * Swagger Name: AvaTaxClient */ class NewAccountRequestModel { @@ -357,7 +364,7 @@ class NewAccountRequestModel */ public $welcomeEmail; /** - * @var CompanyAddress Address information of the account being created. + * @var CompanyAddress */ public $companyAddress; /** @@ -391,6 +398,7 @@ class NewAccountRequestModel } /** * Represents information about a newly created account + * Swagger Name: AvaTaxClient */ class NewAccountModel { @@ -425,6 +433,7 @@ class NewAccountModel } /** * Gets the response for the offer request + * Swagger Name: AvaTaxClient */ class OfferModel { @@ -440,6 +449,7 @@ class OfferModel /** * Represents a request for a free trial account for AvaTax. * Free trial accounts are only available on the Sandbox environment. + * Swagger Name: AvaTaxClient */ class FreeTrialRequestModel { @@ -468,7 +478,7 @@ class FreeTrialRequestModel */ public $campaign; /** - * @var CompanyAddress The Address information of the account + * @var CompanyAddress */ public $companyAddress; /** @@ -486,6 +496,7 @@ class FreeTrialRequestModel } /** * Represents a license key reset request. + * Swagger Name: AvaTaxClient */ class ResetLicenseKeyModel { @@ -500,6 +511,7 @@ class ResetLicenseKeyModel } /** * Represents a license key for this account. + * Swagger Name: AvaTaxClient */ class LicenseKeyModel { @@ -518,6 +530,7 @@ class LicenseKeyModel } /** * An account user who is permitted to use AvaTax. + * Swagger Name: AvaTaxClient */ class AccountLicenseKeyModel { @@ -548,6 +561,7 @@ class AccountLicenseKeyModel } /** * Represents a request to activate an account by reading and accepting its terms and conditions. + * Swagger Name: AvaTaxClient */ class ActivateAccountModel { @@ -562,6 +576,7 @@ class ActivateAccountModel } /** * Represents one configuration setting for this account + * Swagger Name: AvaTaxClient */ class AccountConfigurationModel { @@ -600,6 +615,7 @@ class AccountConfigurationModel } /** * + * Swagger Name: AvaTaxClient */ class AuditEvent { @@ -638,6 +654,7 @@ class AuditEvent * The information on this record was captured by AvaTax when your API call was made. If you are unsure why you * received an error, you can fetch these audit objects and examine the `RequestUrl`, `RequestBody`, and `ErrorMessage` * fields to determine root cause for the error. + * Swagger Name: AvaTaxClient */ class AuditModel { @@ -776,6 +793,7 @@ class AuditModel } /** * TextCase info for input address + * Swagger Name: AvaTaxClient */ class AddressValidationInfo { @@ -822,6 +840,7 @@ class AddressValidationInfo } /** * Represents a base address element. + * Swagger Name: AvaTaxClient */ class AddressInfo { @@ -864,6 +883,7 @@ class AddressInfo } /** * Represents a validated address + * Swagger Name: AvaTaxClient */ class ValidatedAddressInfo { @@ -910,6 +930,7 @@ class ValidatedAddressInfo } /** * Coordinate Info + * Swagger Name: AvaTaxClient */ class CoordinateInfo { @@ -924,6 +945,7 @@ class CoordinateInfo } /** * Information about a tax authority relevant for an address. + * Swagger Name: AvaTaxClient */ class TaxAuthorityInfo { @@ -946,6 +968,7 @@ class TaxAuthorityInfo } /** * Informational or warning messages returned by AvaTax with a transaction + * Swagger Name: AvaTaxClient */ class AvaTaxMessage { @@ -972,11 +995,12 @@ class AvaTaxMessage } /** * Address Resolution Model + * Swagger Name: AvaTaxClient */ class AddressResolutionModel { /** - * @var AddressInfo The original address + * @var AddressInfo */ public $address; /** @@ -984,7 +1008,7 @@ class AddressResolutionModel */ public $validatedAddresses; /** - * @var CoordinateInfo The geospatial coordinates of this address + * @var CoordinateInfo */ public $coordinates; /** @@ -1002,6 +1026,7 @@ class AddressResolutionModel } /** * Model for Advanced Rules when full details are requested + * Swagger Name: AvaTaxClient */ class AdvancedRuleFullDetailsModel { @@ -1084,6 +1109,7 @@ class AdvancedRuleFullDetailsModel } /** * Model for retrieving customer data schema + * Swagger Name: AvaTaxClient */ class AdvancedRuleCustomerDataSchemaModel { @@ -1098,6 +1124,7 @@ class AdvancedRuleCustomerDataSchemaModel } /** * A contact person for a company. + * Swagger Name: AvaTaxClient */ class ContactModel { @@ -1192,6 +1219,7 @@ class ContactModel } /** * Represents a classification for a given item. + * Swagger Name: AvaTaxClient */ class ClassificationModel { @@ -1206,6 +1234,7 @@ class ClassificationModel } /** * Represents a parameter associated with an item. + * Swagger Name: AvaTaxClient */ class ItemParameterModel { @@ -1244,6 +1273,7 @@ class ItemParameterModel } /** * Represents a tag for an item in your company's product catalog. + * Swagger Name: AvaTaxClient */ class ItemTagDetailModel { @@ -1274,6 +1304,7 @@ class ItemTagDetailModel } /** * Represents an item in your company's product catalog. + * Swagger Name: AvaTaxClient */ class ItemModel { @@ -1340,6 +1371,7 @@ class ItemModel } /** * Represents the answer to one local jurisdiction question for a location. + * Swagger Name: AvaTaxClient */ class LocationSettingModel { @@ -1358,6 +1390,7 @@ class LocationSettingModel } /** * The parameter associated with a company location. + * Swagger Name: AvaTaxClient */ class LocationParameterModel { @@ -1385,6 +1418,7 @@ class LocationParameterModel /** * A location where this company does business. * Some jurisdictions may require you to list all locations where your company does business. + * Swagger Name: AvaTaxClient */ class LocationModel { @@ -1507,6 +1541,7 @@ class LocationModel } /** * Represents a parameter associated with a nexus. + * Swagger Name: AvaTaxClient */ class NexusParameterDetailModel { @@ -1544,6 +1579,7 @@ class NexusParameterDetailModel * When calling `CreateNexus` or `UpdateNexus`, all values in your nexus object except for the user-selectable fields * must match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects * by calling `ListNexus`. If any data does not match, AvaTax may not recognize your nexus declaration. + * Swagger Name: AvaTaxClient */ class NexusModel { @@ -1687,6 +1723,7 @@ class NexusModel * A setting can refer to any type of data you need to remember about this company object. * When creating this object, you may define your own `set`, `name`, and `value` parameters. * To define your own values, please choose a `set` name that begins with `X-` to indicate an extension. + * Swagger Name: AvaTaxClient */ class SettingModel { @@ -1722,6 +1759,7 @@ class SettingModel /** * Represents a tax code that can be applied to items on a transaction. * A tax code can have specific rules for specific jurisdictions that change the tax calculation behavior. + * Swagger Name: AvaTaxClient */ class TaxCodeModel { @@ -1795,6 +1833,7 @@ class TaxCodeModel * Because different types of tax rules have different behavior, some fields may change their behavior based on * the type of tax rule selected. Please read the documentation for each field carefully and ensure that * the value you send is appropriate for the type of tax rule. + * Swagger Name: AvaTaxClient */ class TaxRuleProductDetailModel { @@ -1833,6 +1872,7 @@ class TaxRuleProductDetailModel * Because different types of tax rules have different behavior, some fields may change their behavior based on * the type of tax rule selected. Please read the documentation for each field carefully and ensure that * the value you send is appropriate for the type of tax rule. + * Swagger Name: AvaTaxClient */ class TaxRuleModel { @@ -2003,6 +2043,7 @@ class TaxRuleModel } /** * One Universal Product Code object as defined for your company. + * Swagger Name: AvaTaxClient */ class UPCModel { @@ -2061,6 +2102,7 @@ class UPCModel } /** * + * Swagger Name: AvaTaxClient */ class EcmsDetailTaxCodeModel { @@ -2079,6 +2121,7 @@ class EcmsDetailTaxCodeModel } /** * Represents an ECMS record, used internally by AvaTax to track information about exemptions. + * Swagger Name: AvaTaxClient */ class EcmsDetailModel { @@ -2125,6 +2168,7 @@ class EcmsDetailModel } /** * Exempt certificate + * Swagger Name: AvaTaxClient */ class EcmsModel { @@ -2251,6 +2295,7 @@ class EcmsModel } /** * Represents a parameter associated with a company. + * Swagger Name: AvaTaxClient */ class CompanyParameterDetailModel { @@ -2277,6 +2322,7 @@ class CompanyParameterDetailModel } /** * Represents a parameter associated with a company. + * Swagger Name: AvaTaxClient */ class CustomerSupplierModel { @@ -2295,6 +2341,7 @@ class CustomerSupplierModel } /** * A company or business entity. + * Swagger Name: AvaTaxClient */ class CompanyModel { @@ -2461,6 +2508,7 @@ class CompanyModel } /** * Model for changing the approved status of an advanced rule + * Swagger Name: AvaTaxClient */ class ApproveAdvancedRuleModel { @@ -2471,6 +2519,7 @@ class ApproveAdvancedRuleModel } /** * Model for toggling visibility of an advanced rule for an account + * Swagger Name: AvaTaxClient */ class AdvancedRuleVisibilityModel { @@ -2485,6 +2534,7 @@ class AdvancedRuleVisibilityModel } /** * A generic global advanced rule encapsulating a script + * Swagger Name: AvaTaxClient */ class AdvancedRuleModel { @@ -2511,6 +2561,7 @@ class AdvancedRuleModel } /** * Model representing an execution of an advanced rule for a company + * Swagger Name: AvaTaxClient */ class AdvancedRuleExecutionModel { @@ -2543,7 +2594,7 @@ class AdvancedRuleExecutionModel */ public $ruleId; /** - * @var AdvancedRuleModel Advanced rule to execute + * @var AdvancedRuleModel */ public $rule; /** @@ -2557,6 +2608,7 @@ class AdvancedRuleExecutionModel } /** * Model for updating rule execution order + * Swagger Name: AvaTaxClient */ class AdvancedRuleExecutionOrderModel { @@ -2567,6 +2619,7 @@ class AdvancedRuleExecutionOrderModel } /** * Model representing a lookup file for a company + * Swagger Name: AvaTaxClient */ class AdvancedRuleLookupFileModel { @@ -2613,6 +2666,7 @@ class AdvancedRuleLookupFileModel } /** * Represents information about a tax form known to Avalara + * Swagger Name: AvaTaxClient */ class AvaFileFormModel { @@ -2691,6 +2745,7 @@ class AvaFileFormModel } /** * Represents one file in a batch upload. + * Swagger Name: AvaTaxClient */ class BatchFileModel { @@ -2733,6 +2788,7 @@ class BatchFileModel } /** * Represents a batch of uploaded documents. + * Swagger Name: AvaTaxClient */ class BatchModel { @@ -2807,6 +2863,7 @@ class BatchModel } /** * Represents an address to resolve. + * Swagger Name: AvaTaxClient */ class AddressLocationInfo { @@ -2867,40 +2924,46 @@ class AddressLocationInfo * we will be using only latitude and longitude and will discard line, city, region, country and postal code information for the transaction. * Please ensure that you have the correct latitude/longitude information for the addresses prior to using the API. * If you provide either latitude or longitude information but not both, we will be using the line, city, region, country and postal code information for the addresses. + * Swagger Name: AvaTaxClient */ class AddressesModel { /** - * @var AddressLocationInfo If this transaction occurred at a retail point-of-sale location, provide that single address here and leave all other address types null. + * @var AddressLocationInfo */ public $singleLocation; /** - * @var AddressLocationInfo The origination address where the products were shipped from, or from where the services originated. + * @var AddressLocationInfo */ public $shipFrom; /** - * @var AddressLocationInfo The destination address where the products were shipped to, or where the services were delivered. + * @var AddressLocationInfo */ public $shipTo; /** - * @var AddressLocationInfo The place of business where you receive the customer's order. This address type is valid in the United States only and only applies to tangible personal property. + * @var AddressLocationInfo */ public $pointOfOrderOrigin; /** - * @var AddressLocationInfo The place of business where you accept/approve the customer’s order, thereby becoming contractually obligated to make the sale. This address type is valid in the United States only and only applies to tangible personal property. + * @var AddressLocationInfo */ public $pointOfOrderAcceptance; /** - * @var AddressLocationInfo The address where the goods are located or where services are rendered.This address type is valid only for VAT transactions. + * @var AddressLocationInfo */ public $goodsPlaceOrServiceRendered; /** - * @var AddressLocationInfo The address of the buyer importing a good from another country.This address type is valid only for VAT transactions. + * @var AddressLocationInfo */ public $import; + /** + * @var AddressLocationInfo + */ + public $billTo; } /** * Represents a transaction parameter. + * Swagger Name: AvaTaxClient */ class TransactionLineTaxAmountByTaxTypeModel { @@ -2915,6 +2978,7 @@ class TransactionLineTaxAmountByTaxTypeModel } /** * Represents a tax override for a transaction + * Swagger Name: AvaTaxClient */ class TaxOverrideModel { @@ -2941,6 +3005,7 @@ class TaxOverrideModel } /** * Represents a transaction parameter. + * Swagger Name: AvaTaxClient */ class TransactionLineParameterModel { @@ -2959,6 +3024,7 @@ class TransactionLineParameterModel } /** * User Defined fields/Flex Fields at Transaction Line level. + * Swagger Name: AvaTaxClient */ class TransactionLineUserDefinedFieldModel { @@ -2973,6 +3039,7 @@ class TransactionLineUserDefinedFieldModel } /** * Represents one line item in a transaction + * Swagger Name: AvaTaxClient */ class LineItemModel { @@ -2989,7 +3056,7 @@ class LineItemModel */ public $amount; /** - * @var AddressesModel The addresses to use for this transaction line. If you set this value to `null`, or if you omit this element from your API call, then instead the transaction will use the `addresses` from the document level. If you specify any other value besides `null`, only addresses specified for this line will be used for this line. + * @var AddressesModel */ public $addresses; /** @@ -3041,7 +3108,7 @@ class LineItemModel */ public $businessIdentificationNo; /** - * @var TaxOverrideModel Specifies a tax override for this line. + * @var TaxOverrideModel */ public $taxOverride; /** @@ -3087,6 +3154,7 @@ class LineItemModel } /** * Represents a transaction parameter. + * Swagger Name: AvaTaxClient */ class TransactionParameterModel { @@ -3105,6 +3173,7 @@ class TransactionParameterModel } /** * User Defined fields/Flex Fields at Transaction level. + * Swagger Name: AvaTaxClient */ class TransactionUserDefinedFieldModel { @@ -3119,6 +3188,7 @@ class TransactionUserDefinedFieldModel } /** * Create a transaction + * Swagger Name: AvaTaxClient */ class CreateTransactionModel { @@ -3171,7 +3241,7 @@ class CreateTransactionModel */ public $exemptionNo; /** - * @var AddressesModel Default addresses for all lines in this document. These addresses are the default values that will be used for any lines that do not have their own address information. If you specify addresses for a line, then no default addresses will be loaded for that line. + * @var AddressesModel */ public $addresses; /** @@ -3199,7 +3269,7 @@ class CreateTransactionModel */ public $batchCode; /** - * @var TaxOverrideModel Specifies a tax override for the entire document + * @var TaxOverrideModel */ public $taxOverride; /** @@ -3261,6 +3331,7 @@ class CreateTransactionModel } /** * Replace an existing transaction recorded in AvaTax with a new one. + * Swagger Name: AvaTaxClient */ class BatchAdjustTransactionModel { @@ -3285,12 +3356,13 @@ class BatchAdjustTransactionModel */ public $adjustmentDescription; /** - * @var CreateTransactionModel Replace the current transaction with tax data calculated for this new transaction + * @var CreateTransactionModel */ public $newTransaction; } /** * Create or adjust transaction model + * Swagger Name: AvaTaxClient */ class CreateOrAdjustTransactionModel { @@ -3303,12 +3375,13 @@ class CreateOrAdjustTransactionModel */ public $adjustmentDescription; /** - * @var CreateTransactionModel The create transaction model to be created or updated. If the transaction does not exist, create transaction. If the transaction exists, adjust the existing transaction. + * @var CreateTransactionModel */ public $createTransactionModel; } /** * A request to void a previously created transaction. + * Swagger Name: AvaTaxClient */ class BatchVoidTransactionModel { @@ -3332,6 +3405,7 @@ class BatchVoidTransactionModel /** * Represents a transaction batch item. * Only one child transaction model should contain data. + * Swagger Name: AvaTaxClient */ class TransactionBatchItemModel { @@ -3340,24 +3414,25 @@ class TransactionBatchItemModel */ public $memo; /** - * @var CreateTransactionModel Represents a transaction to be created. + * @var CreateTransactionModel */ public $createTransactionModel; /** - * @var BatchAdjustTransactionModel Represents an existing transaction to be adjusted. + * @var BatchAdjustTransactionModel */ public $adjustTransactionModel; /** - * @var CreateOrAdjustTransactionModel Represents a transaction to be created or to be adjusted if exists. + * @var CreateOrAdjustTransactionModel */ public $createOrAdjustTransactionModel; /** - * @var BatchVoidTransactionModel Represents an existing transaction to be voided. + * @var BatchVoidTransactionModel */ public $voidTransactionModel; } /** * Represents a create transaction batch request model. + * Swagger Name: AvaTaxClient */ class CreateTransactionBatchRequestModel { @@ -3372,6 +3447,7 @@ class CreateTransactionBatchRequestModel } /** * Represents a create transaction batch response model. + * Swagger Name: AvaTaxClient */ class CreateTransactionBatchResponseModel { @@ -3438,6 +3514,7 @@ class CreateTransactionBatchResponseModel * directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where * they can follow a step-by-step guide to enter information about their exemption certificates. The * certificates entered will be recorded and automatically linked to their customer record. + * Swagger Name: AvaTaxClient */ class CreateCertExpressInvitationModel { @@ -3466,6 +3543,7 @@ class CreateCertExpressInvitationModel * An exemption reason defines why a certificate allows a customer to be exempt * for purposes of tax calculation. For a full list of defined exemption reasons, * please call the `ListCertificateExemptionReasons` API. + * Swagger Name: AvaTaxClient */ class ExemptionReasonModel { @@ -3480,6 +3558,7 @@ class ExemptionReasonModel } /** * Represents a purchase order number for a transaction + * Swagger Name: AvaTaxClient */ class PoNumberModel { @@ -3496,6 +3575,7 @@ class PoNumberModel * Information about a physical area or zone in which a certificate can apply. * An exposure zone for an exemption certificate will generally be a tax authority such * as a state, country, or local government entity. + * Swagger Name: AvaTaxClient */ class ExposureZoneModel { @@ -3540,6 +3620,7 @@ class ExposureZoneModel * A certificate attribute can be thought of as a feature or flag that is applied to a certificate. * A single certificate can be linked to zero, one, or many certificate attributes. The full list of * attributes can be obtained by calling the `ListCertificateAttributes` API. + * Swagger Name: AvaTaxClient */ class CertificateAttributeModel { @@ -3565,6 +3646,7 @@ class CertificateAttributeModel * can contain information about a customer's eligibility for exemption from sales or use taxes based on * criteria you specify when you store the certificate. To view or manage your certificates directly, please * log onto the administrative website for the product you purchased. + * Swagger Name: AvaTaxClient */ class CertificateModel { @@ -3613,11 +3695,11 @@ class CertificateModel */ public $exemptionNumber; /** - * @var ExemptionReasonModel The exemption reason that CertCapture audit/internal logic identifies for created certificate. + * @var ExemptionReasonModel */ public $validatedExemptionReason; /** - * @var ExemptionReasonModel The exemption reason associated with this certificate. For example, the reason code for exemption for purposes of resale is `RESALE`. For a list of exemption reasons, call `ListCertificateExemptReasons`. + * @var ExemptionReasonModel */ public $exemptionReason; /** @@ -3653,7 +3735,7 @@ class CertificateModel */ public $poNumbers; /** - * @var ExposureZoneModel The exposure zone where this certificate is valid. + * @var ExposureZoneModel */ public $exposureZone; /** @@ -3684,6 +3766,7 @@ class CertificateModel * support additional use cases beyond that supported directly by Avalara's exemption certificate software. * * For more information about custom fields, see the [Avalara Help Center article about custom fields](https://help.avalara.com/0021_Avalara_CertCapture/All_About_CertCapture/Edit_or_Remove_Details_about_Customers). + * Swagger Name: AvaTaxClient */ class CustomFieldModel { @@ -3699,6 +3782,7 @@ class CustomFieldModel /** * A Customer's linked attribute denoting what features applied to the customer. A customer can * be linked to multiple customer attributes and vice versa. + * Swagger Name: AvaTaxClient */ class CustomerAttributeModel { @@ -3729,6 +3813,7 @@ class CustomerAttributeModel } /** * Represents a customer to whom you sell products and/or services. + * Swagger Name: AvaTaxClient */ class CustomerModel { @@ -3845,6 +3930,7 @@ class CustomerModel * The CoverLetter model represents a message sent along with an invitation to use CertExpress to * upload certificates. An invitation allows customers to use CertExpress to upload their exemption * certificates directly; this cover letter explains why the invitation was sent. + * Swagger Name: AvaTaxClient */ class CoverLetterModel { @@ -3899,6 +3985,7 @@ class CoverLetterModel * directly in your connector. Your customer will be redirected to https://app.certexpress.com/ where * they can follow a step-by-step guide to enter information about their exemption certificates. The * certificates entered will be recorded and automatically linked to their customer record. + * Swagger Name: AvaTaxClient */ class CertExpressInvitationModel { @@ -3919,11 +4006,11 @@ class CertExpressInvitationModel */ public $customerCode; /** - * @var CustomerModel The customer who received this invitation. + * @var CustomerModel */ public $customer; /** - * @var CoverLetterModel The attached cover letter object to this request. + * @var CoverLetterModel */ public $coverLetter; /** @@ -3961,6 +4048,7 @@ class CertExpressInvitationModel } /** * Represent what is the current status of certificate request + * Swagger Name: AvaTaxClient */ class CertExpressInvitationStatusModel { @@ -3969,7 +4057,7 @@ class CertExpressInvitationStatusModel */ public $status; /** - * @var CertExpressInvitationModel The CertExpress invitation for the customer. If you specified an email address in the invitation request, this invitation will be sent via email. Otherwise, you are expected to direct the customer using a hyperlink directly in your application. + * @var CertExpressInvitationModel */ public $invitation; } @@ -3978,6 +4066,7 @@ class CertExpressInvitationStatusModel * * This model can be used to determine if your company is able to use the Customers, Certificates, and * CertExpressInvites APIs within AvaTax. + * Swagger Name: AvaTaxClient */ class ProvisionStatusModel { @@ -3996,6 +4085,7 @@ class ProvisionStatusModel } /** * Represents a customer to whom you sell products and/or services. + * Swagger Name: AvaTaxClient */ class LinkCustomersModel { @@ -4006,6 +4096,7 @@ class LinkCustomersModel } /** * A company and account + * Swagger Name: AvaTaxClient */ class MrsCompanyModel { @@ -4052,6 +4143,7 @@ class MrsCompanyModel } /** * Company Initialization Model + * Swagger Name: AvaTaxClient */ class CompanyInitializationModel { @@ -4138,6 +4230,7 @@ class CompanyInitializationModel } /** * Represents the current status of a funding ESign method + * Swagger Name: AvaTaxClient */ class FundingESignMethodReturn { @@ -4156,6 +4249,7 @@ class FundingESignMethodReturn } /** * Status of an Avalara Managed Returns funding configuration for a company + * Swagger Name: AvaTaxClient */ class FundingStatusModel { @@ -4196,7 +4290,7 @@ class FundingStatusModel */ public $documentName; /** - * @var FundingESignMethodReturn MethodReturn + * @var FundingESignMethodReturn */ public $methodReturn; /** @@ -4226,6 +4320,7 @@ class FundingStatusModel } /** * Status of an Avalara Managed Returns funding configuration for a company + * Swagger Name: AvaTaxClient */ class FundingConfigurationModel { @@ -4256,6 +4351,7 @@ class FundingConfigurationModel } /** * + * Swagger Name: AvaTaxClient */ class FundingInitiateModel { @@ -4274,6 +4370,7 @@ class FundingInitiateModel } /** * Represents one configuration setting for this company + * Swagger Name: AvaTaxClient */ class CompanyConfigurationModel { @@ -4312,6 +4409,7 @@ class CompanyConfigurationModel } /** * Represents a change request for filing status for a company + * Swagger Name: AvaTaxClient */ class FilingStatusChangeModel { @@ -4322,6 +4420,7 @@ class FilingStatusChangeModel } /** * Represents a parameter associated with a company. + * Swagger Name: AvaTaxClient */ class CustomerSupplierCountryParamModel { @@ -4360,6 +4459,7 @@ class CustomerSupplierCountryParamModel } /** * The tax rate model. + * Swagger Name: AvaTaxClient */ class ComplianceTaxRateModel { @@ -4410,6 +4510,7 @@ class ComplianceTaxRateModel } /** * Represents information about a single legal taxing jurisdiction within a specific Avalara tax region. + * Swagger Name: AvaTaxClient */ class DenormalizedJurisModel { @@ -4472,6 +4573,7 @@ class DenormalizedJurisModel } /** * The tax region model. + * Swagger Name: AvaTaxClient */ class TaxRegionModel { @@ -4534,6 +4636,7 @@ class TaxRegionModel } /** * The tax region jurisdiction model. + * Swagger Name: AvaTaxClient */ class TaxRegionJurisdictionModel { @@ -4580,6 +4683,7 @@ class TaxRegionJurisdictionModel } /** * A model for aggregated rates. + * Swagger Name: AvaTaxClient */ class ComplianceAggregatedTaxRateModel { @@ -4610,6 +4714,7 @@ class ComplianceAggregatedTaxRateModel } /** * Model for distinct jurisdictions. + * Swagger Name: AvaTaxClient */ class ComplianceJurisdictionModel { @@ -4660,6 +4765,7 @@ class ComplianceJurisdictionModel } /** * A flattened model for jurisdictions and rates. + * Swagger Name: AvaTaxClient */ class ComplianceJurisdictionRateModel { @@ -4714,6 +4820,7 @@ class ComplianceJurisdictionRateModel } /** * Represents a customer to whom you sell products and/or services. + * Swagger Name: AvaTaxClient */ class LinkCertificatesModel { @@ -4724,6 +4831,7 @@ class LinkCertificatesModel } /** * Indicates the customer's exemption status in a specific country and region. + * Swagger Name: AvaTaxClient */ class ExemptionStatusModel { @@ -4732,12 +4840,13 @@ class ExemptionStatusModel */ public $status; /** - * @var CertificateModel Certificate if the customer is exempted + * @var CertificateModel */ public $certificate; } /** * Data source object + * Swagger Name: AvaTaxClient */ class DataSourceModel { @@ -4808,6 +4917,7 @@ class DataSourceModel } /** * Identifies all nexus that match a particular tax form + * Swagger Name: AvaTaxClient */ class NexusByTaxFormModel { @@ -4831,6 +4941,7 @@ class NexusByTaxFormModel /** * Information about Avalara-defined tax code types. * This list is used when creating tax codes and tax rules. + * Swagger Name: AvaTaxClient */ class TaxCodeTypesModel { @@ -4841,6 +4952,7 @@ class TaxCodeTypesModel } /** * Represents a service or a subscription type. + * Swagger Name: AvaTaxClient */ class SubscriptionTypeModel { @@ -4855,6 +4967,7 @@ class SubscriptionTypeModel } /** * Represents a single security role. + * Swagger Name: AvaTaxClient */ class SecurityRoleModel { @@ -4869,6 +4982,7 @@ class SecurityRoleModel } /** * Tax Authority Model + * Swagger Name: AvaTaxClient */ class TaxAuthorityModel { @@ -4891,6 +5005,7 @@ class TaxAuthorityModel } /** * Represents a form that can be filed with a tax authority. + * Swagger Name: AvaTaxClient */ class TaxAuthorityFormModel { @@ -4905,6 +5020,7 @@ class TaxAuthorityFormModel } /** * usage of system defined parameters. + * Swagger Name: AvaTaxClient */ class ParameterUsageModel { @@ -4971,6 +5087,7 @@ class ParameterUsageModel } /** * usage of system defined parameters. + * Swagger Name: AvaTaxClient */ class ClassificationParameterUsageMapModel { @@ -5025,6 +5142,7 @@ class ClassificationParameterUsageMapModel } /** * usage of system defined parameters for returns. + * Swagger Name: AvaTaxClient */ class ReturnsParameterUsageModel { @@ -5079,6 +5197,7 @@ class ReturnsParameterUsageModel } /** * An extra property that can change the behavior of tax transactions. + * Swagger Name: AvaTaxClient */ class ParameterModel { @@ -5149,6 +5268,7 @@ class ParameterModel } /** * Information about questions that the local jurisdictions require for each location + * Swagger Name: AvaTaxClient */ class LocationQuestionModel { @@ -5216,6 +5336,7 @@ class LocationQuestionModel /** * Represents a language-specific localized name of a particular geographic entity such * as a country or a region. + * Swagger Name: AvaTaxClient */ class IsoLocalizedName { @@ -5234,6 +5355,7 @@ class IsoLocalizedName } /** * Represents an ISO 3166 recognized country + * Swagger Name: AvaTaxClient */ class IsoCountryModel { @@ -5264,6 +5386,7 @@ class IsoCountryModel } /** * Represents a region, province, or state within a country + * Swagger Name: AvaTaxClient */ class IsoRegionModel { @@ -5298,6 +5421,7 @@ class IsoRegionModel } /** * Represents a code describing the intended use for a product that may affect its taxability + * Swagger Name: AvaTaxClient */ class EntityUseCodeModel { @@ -5324,6 +5448,7 @@ class EntityUseCodeModel * * To indicate that your company has signed up for a preferred program, specify the `code` value from this * object as the value for the `AvaTax.LC.PreferredProgram` parameter in your transaction. + * Swagger Name: AvaTaxClient */ class PreferredProgramModel { @@ -5354,6 +5479,7 @@ class PreferredProgramModel } /** * Represents an ISO 4217 currency code used for designating the currency of a transaction. + * Swagger Name: AvaTaxClient */ class CurrencyModel { @@ -5372,6 +5498,7 @@ class CurrencyModel } /** * Represents a System Country. + * Swagger Name: AvaTaxClient */ class ProductSystemCountryModel { @@ -5398,6 +5525,7 @@ class ProductSystemCountryModel } /** * Represents a product classification system. + * Swagger Name: AvaTaxClient */ class ProductClassificationSystemModel { @@ -5424,6 +5552,7 @@ class ProductClassificationSystemModel } /** * Tax Authority Type Model + * Swagger Name: AvaTaxClient */ class TaxAuthorityTypeModel { @@ -5442,6 +5571,7 @@ class TaxAuthorityTypeModel } /** * Tax Notice Status Model + * Swagger Name: AvaTaxClient */ class NoticeStatusModel { @@ -5464,6 +5594,7 @@ class NoticeStatusModel } /** * Tax Authority Model + * Swagger Name: AvaTaxClient */ class NoticeCustomerTypeModel { @@ -5486,6 +5617,7 @@ class NoticeCustomerTypeModel } /** * Tax Notice Reason Model + * Swagger Name: AvaTaxClient */ class NoticeReasonModel { @@ -5508,6 +5640,7 @@ class NoticeReasonModel } /** * FilingFrequency Model + * Swagger Name: AvaTaxClient */ class FilingFrequencyModel { @@ -5522,6 +5655,7 @@ class FilingFrequencyModel } /** * Tax Notice FilingType Model + * Swagger Name: AvaTaxClient */ class NoticeFilingTypeModel { @@ -5544,6 +5678,7 @@ class NoticeFilingTypeModel } /** * Tax Notice Type Model + * Swagger Name: AvaTaxClient */ class NoticeTypeModel { @@ -5566,6 +5701,7 @@ class NoticeTypeModel } /** * Tax Authority Model + * Swagger Name: AvaTaxClient */ class NoticeCustomerFundingOptionModel { @@ -5588,6 +5724,7 @@ class NoticeCustomerFundingOptionModel } /** * Tax Notice Priority Model + * Swagger Name: AvaTaxClient */ class NoticePriorityModel { @@ -5610,6 +5747,7 @@ class NoticePriorityModel } /** * NoticeResponsibility Model + * Swagger Name: AvaTaxClient */ class NoticeResponsibilityModel { @@ -5632,6 +5770,7 @@ class NoticeResponsibilityModel } /** * NoticeRootCause Model + * Swagger Name: AvaTaxClient */ class NoticeRootCauseModel { @@ -5654,6 +5793,7 @@ class NoticeRootCauseModel } /** * Represents a verification request using Skyscraper for a company + * Swagger Name: AvaTaxClient */ class requiredFilingCalendarDataFieldModel { @@ -5668,6 +5808,7 @@ class requiredFilingCalendarDataFieldModel } /** * Represents a list of statuses of returns available in skyscraper + * Swagger Name: AvaTaxClient */ class SkyscraperStatusModel { @@ -5706,6 +5847,7 @@ class SkyscraperStatusModel } /** * Represents information about a single legal taxing jurisdiction + * Swagger Name: AvaTaxClient */ class JurisdictionModel { @@ -5787,6 +5929,7 @@ class JurisdictionModel * * During the time period represented by EffDate through EndDate, all tax decisions for addresses matching * this override object will be assigned to the list of jurisdictions designated in this object. + * Swagger Name: AvaTaxClient */ class JurisdictionOverrideModel { @@ -5865,6 +6008,7 @@ class JurisdictionOverrideModel } /** * Represents a Jurisdiction with applicable TaxType, TaxSubType and RateType. + * Swagger Name: AvaTaxClient */ class JurisdictionRateTypeTaxTypeMappingModel { @@ -5919,6 +6063,7 @@ class JurisdictionRateTypeTaxTypeMappingModel } /** * Resource File Type Model + * Swagger Name: AvaTaxClient */ class ResourceFileTypeModel { @@ -5933,6 +6078,7 @@ class ResourceFileTypeModel } /** * Rate type Model + * Swagger Name: AvaTaxClient */ class RateTypeModel { @@ -5951,6 +6097,7 @@ class RateTypeModel } /** * Rate types Model + * Swagger Name: AvaTaxClient */ class RateTypesModel { @@ -5969,6 +6116,7 @@ class RateTypesModel } /** * Represents information about a tax form known to Avalara + * Swagger Name: AvaTaxClient */ class FormMasterModel { @@ -6383,6 +6531,7 @@ class FormMasterModel } /** * Represents a tax type group + * Swagger Name: AvaTaxClient */ class TaxTypeGroupModel { @@ -6421,6 +6570,7 @@ class TaxTypeGroupModel } /** * Represents a tax subtype + * Swagger Name: AvaTaxClient */ class TaxSubTypeModel { @@ -6443,6 +6593,7 @@ class TaxSubTypeModel } /** * Represents a group of tax types + * Swagger Name: AvaTaxClient */ class NexusTaxTypeGroupModel { @@ -6477,6 +6628,7 @@ class NexusTaxTypeGroupModel } /** * Represents a transaction/service type pair for telecommunications tax + * Swagger Name: AvaTaxClient */ class CommunicationsTSPairModel { @@ -6507,6 +6659,7 @@ class CommunicationsTSPairModel } /** * Represents information about a type of telecommunications transaction + * Swagger Name: AvaTaxClient */ class CommunicationsTransactionTypeModel { @@ -6523,6 +6676,7 @@ class CommunicationsTransactionTypeModel * The "Unit of Measurement" model captures information about a type of measurement. Types of measurement refer to * different scales for the same dimension. For example, measurements of type "Distance" may include units of measurement * such as meters, feet, inches, and miles. + * Swagger Name: AvaTaxClient */ class UomModel { @@ -6575,6 +6729,7 @@ class UomModel * * Within AvaTax, the `HsCodeModel` object can refer to sections, chapters, headings, subheadings, or articles. Each object represents one * classification. Many of these objects have child objects underneath them; these child objects are more specific than their parent objects. + * Swagger Name: AvaTaxClient */ class HsCodeModel { @@ -6613,6 +6768,7 @@ class HsCodeModel } /** * Represents a PostalCode and its associated data like: country, region, effective dates, etc. + * Swagger Name: AvaTaxClient */ class PostalCodeModel { @@ -6643,6 +6799,7 @@ class PostalCodeModel } /** * Marketplace Location Output model + * Swagger Name: AvaTaxClient */ class MarketplaceLocationModel { @@ -6689,6 +6846,7 @@ class MarketplaceLocationModel } /** * Marketplace Location Output model + * Swagger Name: AvaTaxClient */ class MarketplaceModel { @@ -6703,6 +6861,7 @@ class MarketplaceModel } /** * Represents a tag for an item in your company's product catalog. + * Swagger Name: AvaTaxClient */ class TagsModel { @@ -6717,6 +6876,7 @@ class TagsModel } /** * Represents a tax type + * Swagger Name: AvaTaxClient */ class TaxTypeModel { @@ -6735,6 +6895,7 @@ class TaxTypeModel } /** * + * Swagger Name: AvaTaxClient */ class UnitOfBasisModel { @@ -6765,6 +6926,7 @@ class UnitOfBasisModel * * By default, you are considered to have exceeded tax thresholds. If you wish to change this default, you can create * a company-distance-threshold object to select the correct behavior for this origin/destination tax calculation process. + * Swagger Name: AvaTaxClient */ class CompanyDistanceThresholdModel { @@ -6803,6 +6965,7 @@ class CompanyDistanceThresholdModel } /** * A model used to initialize a new CertCapture eCommerce token. + * Swagger Name: AvaTaxClient */ class CreateECommerceTokenInputModel { @@ -6813,6 +6976,7 @@ class CreateECommerceTokenInputModel } /** * The resource model returned by the ECommerceTokenController's endpoints. + * Swagger Name: AvaTaxClient */ class ECommerceTokenOutputModel { @@ -6835,6 +6999,7 @@ class ECommerceTokenOutputModel } /** * A model used to request the refresh of a CertCapture eCommerce token. + * Swagger Name: AvaTaxClient */ class RefreshECommerceTokenInputModel { @@ -6845,6 +7010,7 @@ class RefreshECommerceTokenInputModel } /** * Error Transaction Model + * Swagger Name: AvaTaxClient */ class ErrorTransactionOutputModel { @@ -6903,6 +7069,7 @@ class ErrorTransactionOutputModel } /** * + * Swagger Name: AvaTaxClient */ class CappedFetchResult { @@ -6929,6 +7096,7 @@ class CappedFetchResult } /** * Base model class for single error transaction delete request + * Swagger Name: AvaTaxClient */ class ErrorTransactionModelBase { @@ -6943,6 +7111,7 @@ class ErrorTransactionModelBase } /** * Request model for when a user is deleting multiple error transaction + * Swagger Name: AvaTaxClient */ class DeleteErrorTransactionsRequestModel { @@ -6953,6 +7122,7 @@ class DeleteErrorTransactionsRequestModel } /** * Response model of a single error transaction delete + * Swagger Name: AvaTaxClient */ class DeleteErrorTransactionResponseModel { @@ -6971,6 +7141,7 @@ class DeleteErrorTransactionResponseModel } /** * Response model of error transaction batch delete + * Swagger Name: AvaTaxClient */ class DeleteErrorTransactionsResponseModel { @@ -6981,6 +7152,7 @@ class DeleteErrorTransactionsResponseModel } /** * Model that has the matching count for an errorcode + * Swagger Name: AvaTaxClient */ class ErrorCodeOutputModel { @@ -6995,6 +7167,7 @@ class ErrorCodeOutputModel } /** * + * Swagger Name: AvaTaxClient */ class CompanyReturnSettingModel { @@ -7038,6 +7211,7 @@ class CompanyReturnSettingModel /** * Represents a commitment to file a tax return on a recurring basis. * Only used if you subscribe to Avalara Returns. + * Swagger Name: AvaTaxClient */ class FilingCalendarModel { @@ -7194,9 +7368,13 @@ class FilingCalendarModel */ public $fixedPrepaymentAmount; /** - * @var string The type of tax to report on this return. (See MatchingTaxType::* for a list of allowable values) + * @var string DEPRECATED - Date: , Version: , Message: The 'taxTypes' list field should be used going forward. The type of tax to report on this return. (See MatchingTaxType::* for a list of allowable values) */ public $taxTypeId; + /** + * @var string[] The list of tax types to report on this return. + */ + public $taxTypes; /** * @var string DEPRECATED - Date: 9/17/2021, Version: 21.9.0, Message: Field will be no longer be available after the 21.9.0 release. Internal filing notes. */ @@ -7292,6 +7470,7 @@ class FilingCalendarModel } /** * Represents a complex query request to parse using query filter guidelines from Microsoft REST standards + * Swagger Name: AvaTaxClient */ class QueryRequestModel { @@ -7318,6 +7497,7 @@ class QueryRequestModel } /** * Model with options for adding a new filing calendar + * Swagger Name: AvaTaxClient */ class CycleAddOptionModel { @@ -7364,6 +7544,7 @@ class CycleAddOptionModel } /** * Options for expiring a filing calendar. + * Swagger Name: AvaTaxClient */ class CycleExpireOptionModel { @@ -7386,6 +7567,7 @@ class CycleExpireOptionModel } /** * Cycle Safe Expiration results. + * Swagger Name: AvaTaxClient */ class CycleExpireModel { @@ -7404,6 +7586,7 @@ class CycleExpireModel } /** * An edit to be made on a filing calendar. + * Swagger Name: AvaTaxClient */ class FilingCalendarEditModel { @@ -7426,6 +7609,7 @@ class FilingCalendarEditModel } /** * Model with options for actual filing calendar output based on user edits to filing calendar. + * Swagger Name: AvaTaxClient */ class CycleEditOptionModel { @@ -7456,6 +7640,7 @@ class CycleEditOptionModel } /** * Filing Calendar Edit + * Swagger Name: AvaTaxClient */ class CycleSafeFilingCalendarEditModel { @@ -7486,6 +7671,7 @@ class CycleSafeFilingCalendarEditModel } /** * Options for expiring a filing calendar. + * Swagger Name: AvaTaxClient */ class CycleSafeEditRequestModel { @@ -7508,6 +7694,7 @@ class CycleSafeEditRequestModel } /** * Available Cycle object + * Swagger Name: AvaTaxClient */ class AvailableCycleModel { @@ -7530,6 +7717,7 @@ class AvailableCycleModel } /** * Frequency Available object + * Swagger Name: AvaTaxClient */ class FrequencyAvailableModel { @@ -7552,6 +7740,7 @@ class FrequencyAvailableModel } /** * CycleSafe Option Result + * Swagger Name: AvaTaxClient */ class CycleSafeOptionResultModel { @@ -7578,6 +7767,7 @@ class CycleSafeOptionResultModel } /** * + * Swagger Name: AvaTaxClient */ class FilingAnswerModel { @@ -7593,6 +7783,7 @@ class FilingAnswerModel /** * Represents a commitment to file a tax return on a recurring basis. * Only used if you subscribe to Avalara Returns. + * Swagger Name: AvaTaxClient */ class FilingRequestDataModel { @@ -7668,6 +7859,7 @@ class FilingRequestDataModel /** * Represents a commitment to file a tax return on a recurring basis. * Only used if you subscribe to Avalara Returns. + * Swagger Name: AvaTaxClient */ class FilingRequestModel { @@ -7684,7 +7876,7 @@ class FilingRequestModel */ public $filingRequestStatusId; /** - * @var FilingRequestDataModel The data model object of the request + * @var FilingRequestDataModel */ public $data; /** @@ -7706,6 +7898,7 @@ class FilingRequestModel } /** * This is the output model coming from skyscraper services + * Swagger Name: AvaTaxClient */ class LoginVerificationOutputModel { @@ -7728,6 +7921,7 @@ class LoginVerificationOutputModel } /** * Represents a verification request using Skyscraper for a company + * Swagger Name: AvaTaxClient */ class LoginVerificationInputModel { @@ -7770,6 +7964,7 @@ class LoginVerificationInputModel } /** * Represents everything downloaded from resource files + * Swagger Name: AvaTaxClient */ class ResourceFileDownloadResult { @@ -7792,6 +7987,7 @@ class ResourceFileDownloadResult } /** * Response when checking if a company has a POA on file with Avalara + * Swagger Name: AvaTaxClient */ class PowerOfAttorneyCheckModel { @@ -7820,12 +8016,13 @@ class PowerOfAttorneyCheckModel */ public $expirationDate; /** - * @var ResourceFileDownloadResult POA download + * @var ResourceFileDownloadResult */ public $availablePoa; } /** * An attachment associated with a filing return + * Swagger Name: AvaTaxClient */ class FilingAttachmentModel { @@ -7840,6 +8037,7 @@ class FilingAttachmentModel } /** * Filing Returns Model + * Swagger Name: AvaTaxClient */ class FilingReturnModelBasic { @@ -7990,6 +8188,7 @@ class FilingReturnModelBasic } /** * Filing Returns Model + * Swagger Name: AvaTaxClient */ class FiledReturnModel { @@ -8012,6 +8211,7 @@ class FiledReturnModel } /** * A model for return adjustments. + * Swagger Name: AvaTaxClient */ class FilingAdjustmentModel { @@ -8066,6 +8266,7 @@ class FilingAdjustmentModel } /** * A model for return augmentations. + * Swagger Name: AvaTaxClient */ class FilingAugmentationModel { @@ -8104,6 +8305,7 @@ class FilingAugmentationModel } /** * A model for return payments. + * Swagger Name: AvaTaxClient */ class FilingPaymentModel { @@ -8146,6 +8348,7 @@ class FilingPaymentModel } /** * + * Swagger Name: AvaTaxClient */ class Message { @@ -8180,6 +8383,7 @@ class Message } /** * + * Swagger Name: AvaTaxClient */ class WorksheetDocumentLine { @@ -8222,6 +8426,7 @@ class WorksheetDocumentLine } /** * + * Swagger Name: AvaTaxClient */ class WorksheetDocument { @@ -8264,6 +8469,7 @@ class WorksheetDocument } /** * An attachment associated with a filing return + * Swagger Name: AvaTaxClient */ class FilingReturnCreditModel { @@ -8290,6 +8496,7 @@ class FilingReturnCreditModel } /** * Filing Returns Model + * Swagger Name: AvaTaxClient */ class FilingReturnModel { @@ -8506,11 +8713,11 @@ class FilingReturnModel */ public $attachments; /** - * @var FilingReturnCreditModel The excluded carry over credit documents + * @var FilingReturnCreditModel */ public $excludedCarryOverCredits; /** - * @var FilingReturnCreditModel The applied carry over credit documents + * @var FilingReturnCreditModel */ public $appliedCarryOverCredits; /** @@ -8528,6 +8735,7 @@ class FilingReturnModel } /** * Worksheet Checkup Report Suggested Form Model + * Swagger Name: AvaTaxClient */ class FilingsCheckupSuggestedFormModel { @@ -8554,6 +8762,7 @@ class FilingsCheckupSuggestedFormModel } /** * Regions + * Swagger Name: AvaTaxClient */ class FilingRegionModel { @@ -8660,6 +8869,7 @@ class FilingRegionModel } /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. + * Swagger Name: AvaTaxClient */ class FilingModel { @@ -8706,6 +8916,7 @@ class FilingModel } /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. + * Swagger Name: AvaTaxClient */ class FilingsTaxSummaryModel { @@ -8768,6 +8979,7 @@ class FilingsTaxSummaryModel } /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. + * Swagger Name: AvaTaxClient */ class FilingsTaxDetailsModel { @@ -8794,6 +9006,7 @@ class FilingsTaxDetailsModel } /** * Filing Returns Model + * Swagger Name: AvaTaxClient */ class MultiTaxFilingReturnModel { @@ -8854,7 +9067,7 @@ class MultiTaxFilingReturnModel */ public $type; /** - * @var FilingsTaxSummaryModel A summary of all taxes compbined for this period + * @var FilingsTaxSummaryModel */ public $returnTaxSummary; /** @@ -8862,11 +9075,11 @@ class MultiTaxFilingReturnModel */ public $returnTaxDetails; /** - * @var FilingReturnCreditModel The excluded carry over credit documents + * @var FilingReturnCreditModel */ public $excludedCarryOverCredits; /** - * @var FilingReturnCreditModel The applied carry over credit documents + * @var FilingReturnCreditModel */ public $appliedCarryOverCredits; /** @@ -8900,6 +9113,7 @@ class MultiTaxFilingReturnModel } /** * Regions + * Swagger Name: AvaTaxClient */ class MultiTaxFilingRegionModel { @@ -8920,7 +9134,7 @@ class MultiTaxFilingRegionModel */ public $status; /** - * @var FilingsTaxSummaryModel A summary of all taxes compbined for this period + * @var FilingsTaxSummaryModel */ public $regionTaxSummary; /** @@ -8938,6 +9152,7 @@ class MultiTaxFilingRegionModel } /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. + * Swagger Name: AvaTaxClient */ class MultiTaxFilingModel { @@ -8962,7 +9177,7 @@ class MultiTaxFilingModel */ public $type; /** - * @var FilingsTaxSummaryModel A summary of all taxes combined for this period + * @var FilingsTaxSummaryModel */ public $taxSummary; /** @@ -8976,6 +9191,7 @@ class MultiTaxFilingModel } /** * Rebuild a set of filings. + * Swagger Name: AvaTaxClient */ class RebuildFilingsModel { @@ -8986,6 +9202,7 @@ class RebuildFilingsModel } /** * Approve a set of filings. + * Swagger Name: AvaTaxClient */ class ApproveFilingsModel { @@ -8996,6 +9213,7 @@ class ApproveFilingsModel } /** * Cycle Safe Expiration results. + * Swagger Name: AvaTaxClient */ class FilingsCheckupAuthorityModel { @@ -9034,6 +9252,7 @@ class FilingsCheckupAuthorityModel } /** * Results of the Worksheet Checkup report + * Swagger Name: AvaTaxClient */ class FilingsCheckupModel { @@ -9044,6 +9263,7 @@ class FilingsCheckupModel } /** * Account Linkage output model + * Swagger Name: AvaTaxClient */ class FirmClientLinkageOutputModel { @@ -9102,6 +9322,7 @@ class FirmClientLinkageOutputModel } /** * Account Linkage Input model + * Swagger Name: AvaTaxClient */ class FirmClientLinkageInputModel { @@ -9116,6 +9337,7 @@ class FirmClientLinkageInputModel } /** * Represents a request for a new account with Avalara for a new Firm client. + * Swagger Name: AvaTaxClient */ class NewFirmClientAccountRequestModel { @@ -9148,7 +9370,7 @@ class NewFirmClientAccountRequestModel */ public $companyCode; /** - * @var CompanyAddress Address information of the account being created. + * @var CompanyAddress */ public $companyAddress; /** @@ -9162,6 +9384,7 @@ class NewFirmClientAccountRequestModel } /** * Product classification input model. + * Swagger Name: AvaTaxClient */ class ItemClassificationInputModel { @@ -9176,6 +9399,7 @@ class ItemClassificationInputModel } /** * Product classification output model. + * Swagger Name: AvaTaxClient */ class ItemClassificationOutputModel { @@ -9202,6 +9426,7 @@ class ItemClassificationOutputModel } /** * An abridged item model used for syncing product catalogs with AvaTax. + * Swagger Name: AvaTaxClient */ class ItemSyncModel { @@ -9224,6 +9449,7 @@ class ItemSyncModel } /** * Represents a request to sync items. + * Swagger Name: AvaTaxClient */ class SyncItemsRequestModel { @@ -9234,6 +9460,7 @@ class SyncItemsRequestModel } /** * The response returned after an item sync was requested. + * Swagger Name: AvaTaxClient */ class SyncItemsResponseModel { @@ -9244,6 +9471,7 @@ class SyncItemsResponseModel } /** * Represents a bulk upload input model. + * Swagger Name: AvaTaxClient */ class ItemBulkUploadInputModel { @@ -9254,6 +9482,7 @@ class ItemBulkUploadInputModel } /** * Represents a item upload error model. + * Swagger Name: AvaTaxClient */ class ItemUploadErrorModel { @@ -9272,6 +9501,7 @@ class ItemUploadErrorModel } /** * Represents a bulk upload response model. + * Swagger Name: AvaTaxClient */ class ItemBulkUploadOutputModel { @@ -9286,6 +9516,7 @@ class ItemBulkUploadOutputModel } /** * Tells you whether this location object has been correctly set up to the local jurisdiction's standards + * Swagger Name: AvaTaxClient */ class LocationValidationModel { @@ -9300,6 +9531,7 @@ class LocationValidationModel } /** * Expire a location without restriction then update with new remittance and dates. + * Swagger Name: AvaTaxClient */ class UpdateCompanyLocationRemittanceModel { @@ -9318,6 +9550,7 @@ class UpdateCompanyLocationRemittanceModel } /** * Commit this MultiDocument object so that all transactions within it can be reported on a tax filing. + * Swagger Name: AvaTaxClient */ class CommitMultiDocumentModel { @@ -9336,6 +9569,7 @@ class CommitMultiDocumentModel } /** * An individual tax detail element. Represents the amount of tax calculated for a particular jurisdiction, for a particular line in an invoice. + * Swagger Name: AvaTaxClient */ class TransactionLineDetailModel { @@ -9542,6 +9776,7 @@ class TransactionLineDetailModel } /** * Represents information about location types stored in a line + * Swagger Name: AvaTaxClient */ class TransactionLineLocationTypeModel { @@ -9564,6 +9799,7 @@ class TransactionLineLocationTypeModel } /** * One line item on this transaction. + * Swagger Name: AvaTaxClient */ class TransactionLineModel { @@ -9790,6 +10026,7 @@ class TransactionLineModel } /** * An address used within this transaction. + * Swagger Name: AvaTaxClient */ class TransactionAddressModel { @@ -9852,6 +10089,7 @@ class TransactionAddressModel } /** * Information about a location type + * Swagger Name: AvaTaxClient */ class TransactionLocationTypeModel { @@ -9874,6 +10112,7 @@ class TransactionLocationTypeModel } /** * Summary information about an overall transaction. + * Swagger Name: AvaTaxClient */ class TransactionSummary { @@ -9956,6 +10195,7 @@ class TransactionSummary } /** * Tax Details by Tax subtype + * Swagger Name: AvaTaxClient */ class TaxDetailsByTaxSubType { @@ -9982,6 +10222,7 @@ class TaxDetailsByTaxSubType } /** * Tax Details by Tax Type + * Swagger Name: AvaTaxClient */ class TaxDetailsByTaxType { @@ -10012,6 +10253,7 @@ class TaxDetailsByTaxType } /** * Represents a message to be displayed on an invoice. + * Swagger Name: AvaTaxClient */ class InvoiceMessageModel { @@ -10026,6 +10268,7 @@ class InvoiceMessageModel } /** * This object represents a single transaction; for example, a sales invoice or purchase order. + * Swagger Name: AvaTaxClient */ class TransactionModel { @@ -10277,6 +10520,7 @@ class TransactionModel * involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within * a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate * document. This separation of documents allows each seller to file their taxes separately. + * Swagger Name: AvaTaxClient */ class MultiDocumentModel { @@ -10319,6 +10563,7 @@ class MultiDocumentModel } /** * Refund a committed transaction + * Swagger Name: AvaTaxClient */ class RefundTransactionModel { @@ -10349,6 +10594,7 @@ class RefundTransactionModel } /** * Represents one line item in a MultiDocument transaction + * Swagger Name: AvaTaxClient */ class MultiDocumentLineItemModel { @@ -10373,7 +10619,7 @@ class MultiDocumentLineItemModel */ public $amount; /** - * @var AddressesModel The addresses to use for this transaction line. If you set this value to `null`, or if you omit this element from your API call, then instead the transaction will use the `addresses` from the document level. If you specify any other value besides `null`, only addresses specified for this line will be used for this line. + * @var AddressesModel */ public $addresses; /** @@ -10425,7 +10671,7 @@ class MultiDocumentLineItemModel */ public $businessIdentificationNo; /** - * @var TaxOverrideModel Specifies a tax override for this line. + * @var TaxOverrideModel */ public $taxOverride; /** @@ -10476,6 +10722,7 @@ class MultiDocumentLineItemModel * involve a marketplace of vendors, each of which contributes some portion of the final transaction. Within * a MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate * document. This separation of documents allows each seller to file their taxes separately. + * Swagger Name: AvaTaxClient */ class CreateMultiDocumentModel { @@ -10532,7 +10779,7 @@ class CreateMultiDocumentModel */ public $exemptionNo; /** - * @var AddressesModel Default addresses for all lines in this document. These addresses are the default values that will be used for any lines that do not have their own address information. If you specify addresses for a line, then no default addresses will be loaded for that line. + * @var AddressesModel */ public $addresses; /** @@ -10560,7 +10807,7 @@ class CreateMultiDocumentModel */ public $batchCode; /** - * @var TaxOverrideModel Specifies a tax override for the entire document + * @var TaxOverrideModel */ public $taxOverride; /** @@ -10622,6 +10869,7 @@ class CreateMultiDocumentModel } /** * Replace an existing MultiDocument transaction recorded in AvaTax with a new one. + * Swagger Name: AvaTaxClient */ class AdjustMultiDocumentModel { @@ -10634,12 +10882,13 @@ class AdjustMultiDocumentModel */ public $adjustDescription; /** - * @var CreateMultiDocumentModel Replace the current MultiDocument transaction with tax data calculated for this new MultiDocument transaction + * @var CreateMultiDocumentModel */ public $newTransaction; } /** * A request to void a previously created transaction + * Swagger Name: AvaTaxClient */ class VoidTransactionModel { @@ -10651,35 +10900,38 @@ class VoidTransactionModel /** * Contains information about the original API request and response that created * a MultiDocument object. + * Swagger Name: AvaTaxClient */ class ReconstructedMultiDocumentModel { /** - * @var CreateMultiDocumentModel The original request that was used to create a MultiDocument object. + * @var CreateMultiDocumentModel */ public $request; } /** * Represents the exact API request and response from the original transaction API call, if available + * Swagger Name: AvaTaxClient */ class OriginalApiRequestResponseModel { /** - * @var CreateTransactionModel API request + * @var CreateTransactionModel */ public $request; /** - * @var TransactionModel API response + * @var TransactionModel */ public $response; } /** * Information about a previously created MultiDocument transaction + * Swagger Name: AvaTaxClient */ class AuditMultiDocumentModel { /** - * @var ReconstructedMultiDocumentModel Reconstructed API request/response pair that can be used to adjust or re-create this MultiDocument transaction. + * @var ReconstructedMultiDocumentModel */ public $reconstructed; /** @@ -10703,7 +10955,7 @@ class AuditMultiDocumentModel */ public $apiCallStatus; /** - * @var OriginalApiRequestResponseModel Original API request/response + * @var OriginalApiRequestResponseModel */ public $original; } @@ -10714,6 +10966,7 @@ class AuditMultiDocumentModel * MultiDocument object will be moved to the document status `Posted`. * * For more information on document status, see [DocumentStatus](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentStatus/). + * Swagger Name: AvaTaxClient */ class VerifyMultiDocumentModel { @@ -10740,6 +10993,7 @@ class VerifyMultiDocumentModel } /** * Nexus tax type groupe with count + * Swagger Name: AvaTaxClient */ class NexusTaxTypeGroupCountModel { @@ -10754,6 +11008,7 @@ class NexusTaxTypeGroupCountModel } /** * Nexus summary model + * Swagger Name: AvaTaxClient */ class NexusSummaryModel { @@ -10770,6 +11025,7 @@ class NexusSummaryModel * Use this object to provide an address and date range where your company does business. * This address will be used to determine what jurisdictions you should declare nexus and * calculate tax. + * Swagger Name: AvaTaxClient */ class DeclareNexusByAddressModel { @@ -10827,11 +11083,12 @@ class DeclareNexusByAddressModel * as a result of a call to `DeclareNexusByAddress`. For each address, * this object model contains a list of the nexus objects that were declared * according to the geocoding that corresponds to this address. + * Swagger Name: AvaTaxClient */ class NexusByAddressModel { /** - * @var DeclareNexusByAddressModel The address that was provided by the user in the call to `DeclareNexusByAddress` + * @var DeclareNexusByAddressModel */ public $address; /** @@ -10841,6 +11098,7 @@ class NexusByAddressModel } /** * A request to upload a file to Resource Files + * Swagger Name: AvaTaxClient */ class ResourceFileUploadRequestModel { @@ -10875,6 +11133,7 @@ class ResourceFileUploadRequestModel } /** * Represents communication between Avalara and the company regarding the processing of a tax notice. + * Swagger Name: AvaTaxClient */ class NoticeCommentModel { @@ -10931,12 +11190,13 @@ class NoticeCommentModel */ public $modifiedUserId; /** - * @var ResourceFileUploadRequestModel An attachment to the detail + * @var ResourceFileUploadRequestModel */ public $attachmentUploadRequest; } /** * Represents estimated financial results from responding to a tax notice. + * Swagger Name: AvaTaxClient */ class NoticeFinanceModel { @@ -11017,12 +11277,13 @@ class NoticeFinanceModel */ public $modifiedUserId; /** - * @var ResourceFileUploadRequestModel An attachment to the finance detail + * @var ResourceFileUploadRequestModel */ public $attachmentUploadRequest; } /** * NoticeResponsibility Model + * Swagger Name: AvaTaxClient */ class NoticeResponsibilityDetailModel { @@ -11045,6 +11306,7 @@ class NoticeResponsibilityDetailModel } /** * NoticeRootCause Model + * Swagger Name: AvaTaxClient */ class NoticeRootCauseDetailModel { @@ -11069,6 +11331,7 @@ class NoticeRootCauseDetailModel * Represents a letter received from a tax authority regarding tax filing. * These letters often have the warning "Notice" printed at the top, which is why * they are called "Notices". + * Swagger Name: AvaTaxClient */ class NoticeModel { @@ -11263,6 +11526,7 @@ class NoticeModel } /** * Model to create a new tax notice responsibility type. + * Swagger Name: AvaTaxClient */ class CreateNoticeResponsibilityTypeModel { @@ -11281,6 +11545,7 @@ class CreateNoticeResponsibilityTypeModel } /** * Model to create a new tax notice root cause type. + * Swagger Name: AvaTaxClient */ class CreateNoticeRootCauseTypeModel { @@ -11299,6 +11564,7 @@ class CreateNoticeRootCauseTypeModel } /** * Encapsulates the result of uploading a file to the resource system + * Swagger Name: AvaTaxClient */ class ResourceFileUploadResultModel { @@ -11324,6 +11590,7 @@ class ResourceFileUploadResultModel * * An example of a notification would be a message about new software, or a change to AvaTax that may * affect you, or a potential issue with your company's tax profile. + * Swagger Name: AvaTaxClient */ class NotificationModel { @@ -11414,6 +11681,7 @@ class NotificationModel } /** * Password Change Model + * Swagger Name: AvaTaxClient */ class PasswordChangeModel { @@ -11428,6 +11696,7 @@ class PasswordChangeModel } /** * Set Password Model + * Swagger Name: AvaTaxClient */ class SetPasswordModel { @@ -11438,6 +11707,7 @@ class SetPasswordModel } /** * An input model for executing a report detailed to the document line level + * Swagger Name: AvaTaxClient */ class ExportDocumentLineModel { @@ -11486,7 +11756,7 @@ class ExportDocumentLineModel */ public $isLocked; /** - * @var string If set, include only documents associated with this merchantSellerId. + * @var string If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values. */ public $merchantSellerIdentifier; /** @@ -11497,9 +11767,30 @@ class ExportDocumentLineModel * @var boolean Use this parameter when dateFilter = ModifiedDate. For dateFilter = DocumentDate, PaymentDate, TaxDate or ReportingDate, the isModifiedDateSameAsDocumentDate parameter is ignored. Set this parameter to true when you would like to get Documents which have the Document Date same as Modified Date. Defaults to false if not specified. */ public $isModifiedDateSameAsDocumentDate; + /** + * @var string TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc + */ + public $taxGroup; + /** + * @var string The description of the tax + */ + public $taxName; + /** + * @var string The AvaTax tax code or customer tax code associated with the item or SKU in the transaction + */ + public $taxCode; + /** + * @var string The code your business application uses to identify a customer or vendor + */ + public $customerVendorCode; + /** + * @var string Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc. + */ + public $taxSubType; } /** * The output model for report parameter definitions + * Swagger Name: AvaTaxClient */ class ReportParametersModel { @@ -11559,9 +11850,30 @@ class ReportParametersModel * @var boolean If true, modified date will be same as document date If false, modified date will not be same as document date Defaults to false if not specified. */ public $isModifiedDateSameAsDocumentDate; + /** + * @var string TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc + */ + public $taxGroup; + /** + * @var string The description of the tax + */ + public $taxName; + /** + * @var string The AvaTax tax code or customer tax code associated with the item or SKU in the transaction + */ + public $taxCode; + /** + * @var string The code your business application uses to identify a customer or vendor + */ + public $customerVendorCode; + /** + * @var string Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc. + */ + public $taxSubType; } /** * A model for displaying report task metadata + * Swagger Name: AvaTaxClient */ class ReportModel { @@ -11582,7 +11894,7 @@ class ReportModel */ public $reportType; /** - * @var ReportParametersModel The parametes used to build the report + * @var ReportParametersModel */ public $parameters; /** @@ -11620,6 +11932,7 @@ class ReportModel } /** * Point-of-Sale Data Request Model + * Swagger Name: AvaTaxClient */ class PointOfSaleDataRequestModel { @@ -11658,6 +11971,7 @@ class PointOfSaleDataRequestModel } /** * SendSales Request Model. + * Swagger Name: AvaTaxClient */ class SendSalesRequestModel { @@ -11684,6 +11998,7 @@ class SendSalesRequestModel } /** * Indicates one element of a sales tax rate. + * Swagger Name: AvaTaxClient */ class RateModel { @@ -11713,6 +12028,7 @@ class RateModel * * To upgrade to a fully-featured and accurate tax process that handles these scenarios correctly, please * contact Avalara to upgrade to AvaTax! + * Swagger Name: AvaTaxClient */ class TaxRateModel { @@ -11727,6 +12043,7 @@ class TaxRateModel } /** * Replace an existing transaction recorded in AvaTax with a new one. + * Swagger Name: AvaTaxClient */ class AdjustTransactionModel { @@ -11739,7 +12056,7 @@ class AdjustTransactionModel */ public $adjustmentDescription; /** - * @var CreateTransactionModel Replace the current transaction with tax data calculated for this new transaction + * @var CreateTransactionModel */ public $newTransaction; } @@ -11749,6 +12066,7 @@ class AdjustTransactionModel * You may specify one or more of the following fields to verify: `date`, `totalAmount`, or `totalTax`. * This call will report an error if there is any difference between the data stored in AvaTax and * the data stored in your accounting system. + * Swagger Name: AvaTaxClient */ class VerifyTransactionModel { @@ -11769,6 +12087,7 @@ class VerifyTransactionModel * Settle this transaction with your ledger by verifying its amounts. * If the transaction is not yet committed, you may specify the "commit" value to commit it to the ledger and allow it to be reported. * You may also optionally change the transaction's code by specifying the "newTransactionCode" value. + * Swagger Name: AvaTaxClient */ class ChangeTransactionCodeModel { @@ -11779,6 +12098,7 @@ class ChangeTransactionCodeModel } /** * Commit this transaction as permanent so that it can be reported on a tax filing. + * Swagger Name: AvaTaxClient */ class CommitTransactionModel { @@ -11792,24 +12112,26 @@ class CommitTransactionModel * * You may use this endpoint to verify the transaction, change the transaction's code, and commit the transaction for reporting purposes. * This endpoint may be used to execute any or all of these actions at once. + * Swagger Name: AvaTaxClient */ class SettleTransactionModel { /** - * @var VerifyTransactionModel To verify this transaction, you may provide information in this field. If you leave this field null, the transaction will not be verified. + * @var VerifyTransactionModel */ public $verify; /** - * @var ChangeTransactionCodeModel To change the code for this transaction, you may provide information in this field. If you leave this field null, the transaction's code will not be changed. + * @var ChangeTransactionCodeModel */ public $changeCode; /** - * @var CommitTransactionModel To commit this transaction so that it can be reported on a tax filing, you may provide information in this field. If you leave this field null, the transaction's commit status will not be changed. If you use Avalara's Managed Returns Service, committing a transaction will allow that transaction to be filed. + * @var CommitTransactionModel */ public $commit; } /** * Commit this transaction as permanent + * Swagger Name: AvaTaxClient */ class LockTransactionModel { @@ -11820,6 +12142,7 @@ class LockTransactionModel } /** * Bulk lock documents model + * Swagger Name: AvaTaxClient */ class BulkLockTransactionModel { @@ -11834,6 +12157,7 @@ class BulkLockTransactionModel } /** * Returns information about transactions that were locked + * Swagger Name: AvaTaxClient */ class BulkLockTransactionResult { @@ -11848,16 +12172,18 @@ class BulkLockTransactionResult * * Note that the API changes over time, and this reconstructed model is likely different from the exact request * that was originally used to create this transaction. + * Swagger Name: AvaTaxClient */ class ReconstructedApiRequestResponseModel { /** - * @var CreateTransactionModel API request + * @var CreateTransactionModel */ public $request; } /** * Information about a previously created transaction + * Swagger Name: AvaTaxClient */ class AuditTransactionModel { @@ -11866,7 +12192,7 @@ class AuditTransactionModel */ public $companyId; /** - * @var ReconstructedApiRequestResponseModel Reconstructed API request/response + * @var ReconstructedApiRequestResponseModel */ public $reconstructed; /** @@ -11882,12 +12208,13 @@ class AuditTransactionModel */ public $apiCallStatus; /** - * @var OriginalApiRequestResponseModel Original API request/response + * @var OriginalApiRequestResponseModel */ public $original; } /** * Model to add specific lines to exising transaction + * Swagger Name: AvaTaxClient */ class AddTransactionLineModel { @@ -11914,6 +12241,7 @@ class AddTransactionLineModel } /** * Model to specify lines to be removed + * Swagger Name: AvaTaxClient */ class RemoveTransactionLineModel { @@ -11940,6 +12268,7 @@ class RemoveTransactionLineModel } /** * This object represents a single determination factor for a line that is being inspected through the InspectLine API. + * Swagger Name: AvaTaxClient */ class DeterminationFactorModel { @@ -11966,6 +12295,7 @@ class DeterminationFactorModel } /** * Response model used as output for InspectLine API. + * Swagger Name: AvaTaxClient */ class InspectResponseModel { @@ -11974,8 +12304,56 @@ class InspectResponseModel */ public $determinationFactors; } +/** + * + * Swagger Name: AvaTaxClient + */ +class CompanyUserDefinedFieldModel +{ + /** + * @var int The id of the datasource. + */ + public $id; + /** + * @var int The id of the company to which the datasource belongs to. + */ + public $companyId; + /** + * @var string The extractor/connector id. + */ + public $name; + /** + * @var string The unique ID number of this connection. + */ + public $friendlyName; + /** + * @var string The unique ID number of this connection. (See UserDefinedFieldDataType::* for a list of allowable values) + */ + public $dataType; + /** + * @var string The category of user defined type For Example: Document level or Line level UDF. (See UserDefinedFieldType::* for a list of allowable values) + */ + public $userDefinedFieldType; + /** + * @var int The User ID of the user who created this record. + */ + public $createdUserId; + /** + * @var string The date when this record was created. + */ + public $createdDate; + /** + * @var int The user ID of the user who last modified this record. + */ + public $modifiedUserId; + /** + * @var string The date/time when this record was last modified. + */ + public $modifiedDate; +} /** * User Entitlement Model + * Swagger Name: AvaTaxClient */ class UserEntitlementModel { @@ -11994,6 +12372,7 @@ class UserEntitlementModel } /** * Ping Result Model + * Swagger Name: AvaTaxClient */ class PingResultModel { @@ -12029,4 +12408,88 @@ class PingResultModel * @var string The connected Salesforce account. */ public $crmid; +} +/** + * The Response of the /shippingverify endpoint. Describes the result of checking all applicable shipping rules against each line in the transaction. + * Swagger Name: AvaTaxBeverageClient + */ +class ShippingVerifyResult +{ + /** + * @var boolean Whether every line in the transaction is compliant. + */ + public $compliant; + /** + * @var string A short description of the result of the compliance check. + */ + public $message; + /** + * @var string A detailed description of the result of each of the passed checks made against this transaction, separated by line. + */ + public $successMessages; + /** + * @var string A detailed description of the result of each of the failed checks made against this transaction, separated by line. + */ + public $failureMessages; + /** + * @var string[] An enumeration of all the failure codes received across all lines. + */ + public $failureCodes; + /** + * @var string[] An enumeration of all the warning codes received across all lines that a determination could not be made for. + */ + public $warningCodes; + /** + * @var object[] Describes the results of the checks made for each line in the transaction. + */ + public $lines; +} +/** + * Message Object + * Swagger Name: AvaTaxBeverageClient + */ +class ErrorDetails +{ + /** + * @var object An object holding details about the error. + */ + public $error; +} +/** + * The Request for the /ageVerification/verify endpoint. Describes information about the person whose age is being verified. + * Swagger Name: AvaTaxBeverageClient + */ +class AgeVerifyRequest +{ + /** + * @var string + */ + public $firstName; + /** + * @var string + */ + public $lastName; + /** + * @var object + */ + public $address; + /** + * @var string The value should be ISO-8601 compliant (e.g. 2020-07-21). + */ + public $DOB; +} +/** + * The Result of a call to the /ageVerification/verify endpoint. + * Swagger Name: AvaTaxBeverageClient + */ +class AgeVerifyResult +{ + /** + * @var boolean Describes whether the individual meets or exceeds the minimum legal drinking age. + */ + public $isOfAge; + /** + * @var AgeVerifyResult[] A list of failure codes describing why a *false* age determination was made. + */ + public $failureCodes; }?> \ No newline at end of file From 87c70ccfa92cbc5f44da5f256751dd0286e4696e Mon Sep 17 00:00:00 2001 From: svc-developer <75763841+svc-developer@users.noreply.github.com> Date: Tue, 14 Dec 2021 14:43:29 -0800 Subject: [PATCH 3/3] Update Client.php --- src/Client.php | 1 - 1 file changed, 1 deletion(-) diff --git a/src/Client.php b/src/Client.php index fa3ffaf..97abd21 100644 --- a/src/Client.php +++ b/src/Client.php @@ -228,7 +228,6 @@ protected function restCall($apiUrl, $verb, $guzzleParams, $apiversion='') } } catch (\Exception $e) { - echo "in excpetion"; if (!$this->catchExceptions) { throw $e; }