From 26b8e833275ace064c69bd529401727f341c716d Mon Sep 17 00:00:00 2001 From: svc-developer Date: Thu, 15 Jun 2023 17:55:44 +0000 Subject: [PATCH] 23.6.1 --- src/Constants.php | 48 +- src/Methods.php | 12309 ++++++++++++++++++++++---------------------- src/Models.php | 8 + 3 files changed, 6168 insertions(+), 6197 deletions(-) diff --git a/src/Constants.php b/src/Constants.php index 9c40afd..84083e5 100644 --- a/src/Constants.php +++ b/src/Constants.php @@ -2,7 +2,7 @@ namespace Avalara; use GuzzleHttp\Client; -define('AVATAX_SDK_VERSION', '23.5.0'); +define('AVATAX_SDK_VERSION', '23.6.1'); /***************************************************************************** * * @@ -990,6 +990,51 @@ class DeliveryTerms * Delivery Duty Paid (DDP) implies that Duty And Tax will be paid by the Shipper */ const C_DDP = 2; + + /** + * Free on Board + */ + const C_FOB = 3; + + /** + * Free Carrier + */ + const C_FCA = 4; + + /** + * Free Alongside Ship + */ + const C_FAS = 5; + + /** + * Ex Works + */ + const C_EXW = 6; + + /** + * Delivered at Place Unloaded + */ + const C_DPU = 7; + + /** + * Carriage Paid To + */ + const C_CPT = 8; + + /** + * Carriage Insurance Paid To + */ + const C_CIP = 9; + + /** + * Cost, Insurance, and Freight + */ + const C_CIF = 10; + + /** + * Cost And Freight + */ + const C_CFR = 11; } @@ -1565,6 +1610,7 @@ class ErrorCodeId const C_INVALIDSYSTEMCODE = 1735; const C_NOITEMSFORCLASSIFICATION = 1736; const C_INVALIDFILENAME = 1737; + const C_NOCLASSIFICATIONFORSAMEHSCODE = 1738; /** * SendSales API errors diff --git a/src/Methods.php b/src/Methods.php index e983d82..0aed556 100644 --- a/src/Methods.php +++ b/src/Methods.php @@ -1,30 +1,30 @@ - [], - 'body' => json_encode($model) - ]; + * @param ResetLicenseKeyModel $model A request confirming that you wish to reset the license key of this account. + * @return \stdClass + */ + public function accountResetLicenseKey($id, $model) { + $path = "/api/v2/accounts/{$id}/resetlicensekey"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Activate an account by accepting terms and conditions - * + } + + /** + * Activate an account by accepting terms and conditions + * * Activate the account specified by the unique accountId number. * * This activation request can only be called by account administrators. You must indicate @@ -74,25 +74,25 @@ public function accountResetLicenseKey($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function activateAccount($id, $model) { - $path = "/api/v2/accounts/{$id}/activate"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ActivateAccountModel $model The activation request + * @return \stdClass + */ + public function activateAccount($id, $model) { + $path = "/api/v2/accounts/{$id}/activate"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve audit history for an account. - * + } + + /** + * Retrieve audit history for an account. + * * Retrieve audit trace history for an account. * * Your audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate @@ -110,28 +110,28 @@ public function activateAccount($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. * @param string $end The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time. * @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. - * @return \stdClass - */ - public function auditAccount($id, $start, $end, $top=null, $skip=null) { - $path = "/api/v2/accounts/{$id}/audit"; - $guzzleParams = [ - 'query' => ['start' => $start, 'end' => $end, '$top' => $top, '$skip' => $skip], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create license key for this account - * + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @return \stdClass + */ + public function auditAccount($id, $start, $end, $top=null, $skip=null) { + $path = "/api/v2/accounts/{$id}/audit"; + $guzzleParams = [ + 'query' => ['start' => $start, 'end' => $end, '$top' => $top, '$skip' => $skip], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create license key for this account + * * Creates a new license key for this account. * * To create a license key for your account, you must specify the ID of the account and license key name. @@ -145,25 +145,25 @@ public function auditAccount($id, $start, $end, $top=null, $skip=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $id The ID of the account you wish to update. - * @param AccountLicenseKeyModel $model - * @return \stdClass - */ - public function createLicenseKey($id, $model) { - $path = "/api/v2/accounts/{$id}/licensekey"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param AccountLicenseKeyModel $model + * @return \stdClass + */ + public function createLicenseKey($id, $model) { + $path = "/api/v2/accounts/{$id}/licensekey"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete license key for this account by license key name - * + } + + /** + * Delete license key for this account by license key name + * * Deletes the license key for this account using license key name. * * To delete a license key for your account, you must specify the accountID of the account and license key name. @@ -172,25 +172,25 @@ public function createLicenseKey($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteLicenseKey($id, $licensekeyname) { - $path = "/api/v2/accounts/{$id}/licensekey/{$licensekeyname}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param string $licensekeyname The license key name you wish to update. + * @return \stdClass + */ + public function deleteLicenseKey($id, $licensekeyname) { + $path = "/api/v2/accounts/{$id}/licensekey/{$licensekeyname}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single account - * + } + + /** + * Retrieve a single account + * * Get the account object identified by this URL. * You may use the '$include' parameter to fetch additional nested data: * @@ -199,25 +199,25 @@ public function deleteLicenseKey($id, $licensekeyname) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @return \stdClass - */ - public function getAccount($id, $include=null) { - $path = "/api/v2/accounts/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get configuration settings for this account - * + * @param string $include A comma separated list of special fetch options + * @return \stdClass + */ + public function getAccount($id, $include=null) { + $path = "/api/v2/accounts/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Get configuration settings for this account + * * Retrieve a list of all configuration settings tied to this account. * * Configuration settings provide you with the ability to control features of your account and of your @@ -233,67 +233,67 @@ public function getAccount($id, $include=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function getAccountConfiguration($id) { - $path = "/api/v2/accounts/{$id}/configuration"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id + * @return \stdClass + */ + public function getAccountConfiguration($id) { + $path = "/api/v2/accounts/{$id}/configuration"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve license key by license key name - * + } + + /** + * Retrieve license key by license key name + * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @return \stdClass - */ - public function getLicenseKey($id, $licensekeyname) { - $path = "/api/v2/accounts/{$id}/licensekey/{$licensekeyname}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all license keys for this account - * + * @param string $licensekeyname The ID of the account to retrieve + * @return \stdClass + */ + public function getLicenseKey($id, $licensekeyname) { + $path = "/api/v2/accounts/{$id}/licensekey/{$licensekeyname}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all license keys for this account + * * Gets list of all the license keys used by the account. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * - * @param int $id The ID of the account to retrieve - * @return \stdClass - */ - public function getLicenseKeys($id) { - $path = "/api/v2/accounts/{$id}/licensekeys"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all accounts - * + * @param int $id The ID of the account to retrieve + * @return \stdClass + */ + public function getLicenseKeys($id) { + $path = "/api/v2/accounts/{$id}/licensekeys"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all accounts + * * List all account objects that can be seen by the current user. * * This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account. @@ -309,28 +309,28 @@ public function getLicenseKeys($id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryAccounts($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/accounts"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Change configuration settings for this account - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryAccounts($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/accounts"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Change configuration settings for this account + * * Update configuration settings tied to this account. * * Configuration settings provide you with the ability to control features of your account and of your @@ -346,25 +346,25 @@ public function queryAccounts($include=null, $filter=null, $top=null, $skip=null * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $id - * @param AccountConfigurationModel[] $model - * @return \stdClass - */ - public function setAccountConfiguration($id, $model) { - $path = "/api/v2/accounts/{$id}/configuration"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param AccountConfigurationModel[] $model + * @return \stdClass + */ + public function setAccountConfiguration($id, $model) { + $path = "/api/v2/accounts/{$id}/configuration"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve geolocation information for a specified address - * + } + + /** + * Retrieve geolocation information for a specified address + * * Resolve an address against Avalara's address-validation system. If the address can be resolved, this API * provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used * to identify how closely this address can be located. If the address cannot be clearly located, use the @@ -380,8 +380,8 @@ public function setAccountConfiguration($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AutoAddress. - * Swagger Name: AvaTaxClient + * * This API depends on the following active services:*Required* (all): AutoAddress. + * Swagger Name: AvaTaxClient * * @param string $line1 Line 1 * @param string $line2 Line 2 @@ -390,21 +390,21 @@ public function setAccountConfiguration($id, $model) { * @param string $region State / Province / Region * @param string $postalCode Postal Code / Zip Code * @param string $country Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list) - * @param string $textCase selectable text case for address validation (See TextCase::* for a list of allowable values) - * @return \stdClass - */ - public function resolveAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $textCase) { - $path = "/api/v2/addresses/resolve"; - $guzzleParams = [ - '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, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve geolocation information for a specified address - * + * @param string $textCase selectable text case for address validation (See TextCase::* for a list of allowable values) + * @return \stdClass + */ + public function resolveAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $textCase) { + $path = "/api/v2/addresses/resolve"; + $guzzleParams = [ + '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, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve geolocation information for a specified address + * * Resolve an address against Avalara's address-validation system. If the address can be resolved, this API * provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used * to identify how closely this address can be located. If the address cannot be clearly located, use the @@ -415,243 +415,243 @@ public function resolveAddress($line1, $line2, $line3, $city, $region, $postalCo * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AutoAddress. - * Swagger Name: AvaTaxClient - * - * @param AddressValidationInfo $model The address to resolve - * @return \stdClass - */ - public function resolveAddressPost($model) { - $path = "/api/v2/addresses/resolve"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * This API depends on the following active services:*Required* (all): AutoAddress. + * Swagger Name: AvaTaxClient + * + * @param AddressValidationInfo $model The address to resolve + * @return \stdClass + */ + public function resolveAddressPost($model) { + $path = "/api/v2/addresses/resolve"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a lookup file for a company - * - * - * Swagger Name: AvaTaxClient + } + + /** + * 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 - * @param AdvancedRuleLookupFileModel $model The lookup file you wish to create - * @return \stdClass - */ - public function createCompanyLookupFile($accountId, $companyId, $model) { - $path = "/api/v2/advancedrules/accounts/{$accountId}/companies/{$companyId}/lookupFiles"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param AdvancedRuleLookupFileModel $model The lookup file you wish to create + * @return \stdClass + */ + public function createCompanyLookupFile($accountId, $companyId, $model) { + $path = "/api/v2/advancedrules/accounts/{$accountId}/companies/{$companyId}/lookupFiles"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a lookup file - * - * - * Swagger Name: AvaTaxClient + } + + /** + * 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 - * @return \stdClass - */ - public function deleteLookupFile($accountId, $id) { - $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param string $id The unique ID/GUID for the company lookup file to be deleted + * @return \stdClass + */ + public function deleteLookupFile($accountId, $id) { + $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get the lookup files for a company - * - * - * Swagger Name: AvaTaxClient + } + + /** + * 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 - * @return \stdClass - */ - public function getCompanyLookupFiles($accountId, $companyId) { - $path = "/api/v2/advancedrules/accounts/{$accountId}/companies/{$companyId}/lookupFiles"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get a lookup file for an accountId and companyLookupFileId - * - * - * Swagger Name: AvaTaxClient + * @param int $companyId The ID of the company for which to retrieve lookup files + * @return \stdClass + */ + public function getCompanyLookupFiles($accountId, $companyId) { + $path = "/api/v2/advancedrules/accounts/{$accountId}/companies/{$companyId}/lookupFiles"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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 - * @return \stdClass - */ - public function getLookupFile($accountId, $id) { - $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a lookup file - * - * - * Swagger Name: AvaTaxClient + * @param string $id The unique ID/GUID of the company lookup file to return + * @return \stdClass + */ + public function getLookupFile($accountId, $id) { + $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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 - * @param AdvancedRuleLookupFileModel $model The new values to update the lookup file - * @return \stdClass - */ - public function updateLookupFile($accountId, $id, $model) { - $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param AdvancedRuleLookupFileModel $model The new values to update the lookup file + * @return \stdClass + */ + public function updateLookupFile($accountId, $id, $model) { + $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new AvaFileForm - * + } + + /** + * Create a new AvaFileForm + * * Create one or more AvaFileForms * A 'AvaFileForm' represents a form supported by our returns team * * ### Security Policies * * * 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 \stdClass - */ - public function createAvaFileForms($model) { - $path = "/api/v2/avafileforms"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function createAvaFileForms($model) { + $path = "/api/v2/avafileforms"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single AvaFileForm - * + } + + /** + * Delete a single AvaFileForm + * * Marks the existing AvaFileForm object at this URL as deleted. * * ### Security Policies * * * 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 \stdClass - */ - public function deleteAvaFileForm($id) { - $path = "/api/v2/avafileforms/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * * 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 \stdClass + */ + public function deleteAvaFileForm($id) { + $path = "/api/v2/avafileforms/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single AvaFileForm - * + } + + /** + * Retrieve a single AvaFileForm + * * Get the AvaFileForm object identified by this URL. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, 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 \stdClass - */ - public function getAvaFileForm($id) { - $path = "/api/v2/avafileforms/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all AvaFileForms - * + * * 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 \stdClass + */ + public function getAvaFileForm($id) { + $path = "/api/v2/avafileforms/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all AvaFileForms + * * Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . * Paginate your results using the `$top`, `$skip`, and `$orderby` parameters. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, 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 + * * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/avafileforms"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a AvaFileForm - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/avafileforms"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a AvaFileForm + * * All data from the existing object will be replaced with data in the object you PUT. * To set a field's value to null, you may either set its value to null or omit that field from the object you post. * * ### Security Policies * * * 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 + * * 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. - * @return \stdClass - */ - public function updateAvaFileForm($id, $model) { - $path = "/api/v2/avafileforms/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param AvaFileFormModel $model The AvaFileForm model you wish to update. + * @return \stdClass + */ + public function updateAvaFileForm($id, $model) { + $path = "/api/v2/avafileforms/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Cancel an in progress batch - * + } + + /** + * Cancel an in progress batch + * * Marks the in progress batch identified by this URL as cancelled. * * Only JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message. @@ -667,25 +667,25 @@ public function updateAvaFileForm($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function cancelBatch($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/batches/{$id}/cancel"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the batch to cancel. + * @return \stdClass + */ + public function cancelBatch($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/batches/{$id}/cancel"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new batch - * + } + + /** + * Create a new batch + * * Create one or more new batch objects attached to this company. * * Each batch object may have one or more file objects (currently only one file is supported). @@ -708,25 +708,25 @@ public function cancelBatch($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createBatches($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/batches"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param BatchModel[] $model The batch you wish to create. + * @return \stdClass + */ + public function createBatches($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/batches"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new transaction batch - * + } + + /** + * Create a new transaction batch + * * Create a new transaction batch objects attached to this company. * * When a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be @@ -747,25 +747,25 @@ public function createBatches($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createTransactionBatch($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/batches/transactions"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CreateTransactionBatchRequestModel $model The transaction batch you wish to create. + * @return \stdClass + */ + public function createTransactionBatch($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/batches/transactions"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single batch - * + } + + /** + * Delete a single batch + * * Marks the batch identified by this URL as deleted. * * If you attempt to delete a batch that is being processed, you will receive an error message. @@ -779,49 +779,49 @@ public function createTransactionBatch($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteBatch($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/batches/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the batch to delete. + * @return \stdClass + */ + public function deleteBatch($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/batches/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Download a single batch file - * + } + + /** + * Download a single batch file + * * Download a single batch file identified by this URL. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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 - * @param int $id The primary key of this batch file object - * @return \stdClass - */ - public function downloadBatch($companyId, $batchId, $id) { - $path = "/api/v2/companies/{$companyId}/batches/{$batchId}/files/{$id}/attachment"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single batch - * + * @param int $id The primary key of this batch file object + * @return \stdClass + */ + public function downloadBatch($companyId, $batchId, $id) { + $path = "/api/v2/companies/{$companyId}/batches/{$batchId}/files/{$id}/attachment"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single batch + * * Get the batch object identified by this URL. A batch object is a large * collection of API calls stored in a compact file. * @@ -840,25 +840,25 @@ public function downloadBatch($companyId, $batchId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function getBatch($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/batches/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all batches for this company - * + * @param int $id The primary key of this batch + * @return \stdClass + */ + public function getBatch($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/batches/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all batches for this company + * * List all batch objects attached to the specified company. * * A batch object is a large collection of API calls stored in a compact file. @@ -883,29 +883,29 @@ public function getBatch($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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 * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listBatchesByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/batches"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all batches - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listBatchesByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/batches"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all batches + * * Get multiple batch objects across all companies. * * A batch object is a large collection of API calls stored in a compact file. @@ -927,28 +927,28 @@ public function listBatchesByCompany($companyId, $filter=null, $include=null, $t * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryBatches($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/batches"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a CertExpress invitation - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryBatches($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/batches"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create a CertExpress invitation + * * Creates an invitation for a customer to self-report certificates using the CertExpress website. * * This invitation is delivered by your choice of method, or you can present a hyperlink to the user @@ -968,26 +968,26 @@ public function queryBatches($filter=null, $include=null, $top=null, $skip=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param CreateCertExpressInvitationModel[] $model the requests to send out to customers - * @return \stdClass - */ - public function createCertExpressInvitation($companyId, $customerCode, $model) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certexpressinvites"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CreateCertExpressInvitationModel[] $model the requests to send out to customers + * @return \stdClass + */ + public function createCertExpressInvitation($companyId, $customerCode, $model) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certexpressinvites"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single CertExpress invitation - * + } + + /** + * Retrieve a single CertExpress invitation + * * Retrieve an existing CertExpress invitation sent to a customer. * * A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information @@ -1007,27 +1007,27 @@ public function createCertExpressInvitation($companyId, $customerCode, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 * @param int $id The unique ID number of this CertExpress invitation - * @param string $include OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. - * @return \stdClass - */ - public function getCertExpressInvitation($companyId, $customerCode, $id, $include=null) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certexpressinvites/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List CertExpress invitations - * + * @param string $include OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. + * @return \stdClass + */ + public function getCertExpressInvitation($companyId, $customerCode, $id, $include=null) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certexpressinvites/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List CertExpress invitations + * * Retrieve CertExpress invitations sent by this company. * * A CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information @@ -1047,29 +1047,29 @@ public function getCertExpressInvitation($companyId, $customerCode, $id, $includ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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. * @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:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCertExpressInvitations($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/certexpressinvites"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create certificates for this company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCertExpressInvitations($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/certexpressinvites"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create certificates for this company + * * Record one or more certificates document for this company. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1095,26 +1095,26 @@ public function listCertExpressInvitations($companyId, $include=null, $filter=nu * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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. - * @param CertificateModel[] $model Certificates to be created - * @return \stdClass - */ - public function createCertificates($companyId, $preValidatedExemptionReason, $model) { - $path = "/api/v2/companies/{$companyId}/certificates"; - $guzzleParams = [ - 'query' => ['$preValidatedExemptionReason' => null === $preValidatedExemptionReason ? null : json_encode($preValidatedExemptionReason)], - 'body' => json_encode($model) - ]; + * @param CertificateModel[] $model Certificates to be created + * @return \stdClass + */ + public function createCertificates($companyId, $preValidatedExemptionReason, $model) { + $path = "/api/v2/companies/{$companyId}/certificates"; + $guzzleParams = [ + 'query' => ['$preValidatedExemptionReason' => null === $preValidatedExemptionReason ? null : json_encode($preValidatedExemptionReason)], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Revoke and delete a certificate - * + } + + /** + * Revoke and delete a certificate + * * Revoke the certificate identified by this URL, then delete it. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1132,25 +1132,25 @@ public function createCertificates($companyId, $preValidatedExemptionReason, $mo * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function deleteCertificate($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The unique ID number of this certificate + * @return \stdClass + */ + public function deleteCertificate($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Download an image for this certificate - * + } + + /** + * Download an image for this certificate + * * Download an image or PDF file for this certificate. * * This API can be used to download either a single-page preview of the certificate or a full PDF document. @@ -1169,27 +1169,27 @@ public function deleteCertificate($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 * @param int $page If you choose `$type`=`Jpeg`, you must specify which page number to retrieve. - * @param string $type The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values) - * @return \stdClass - */ - public function downloadCertificateImage($companyId, $id, $page, $type) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attachment"; - $guzzleParams = [ - 'query' => ['$page' => $page, '$type' => $type], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single certificate - * + * @param string $type The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values) + * @return \stdClass + */ + public function downloadCertificateImage($companyId, $id, $page, $type) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attachment"; + $guzzleParams = [ + 'query' => ['$page' => $page, '$type' => $type], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single certificate + * * Get the current certificate identified by this URL. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1211,26 +1211,26 @@ public function downloadCertificateImage($companyId, $id, $page, $type) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @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. - * @return \stdClass - */ - public function getCertificate($companyId, $id, $include=null) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Check a company's exemption certificate status. - * + * @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. + * @return \stdClass + */ + public function getCertificate($companyId, $id, $include=null) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Check a company's exemption certificate status. + * * Checks whether this company is configured to use exemption certificates in AvaTax. * * Exemption certificates are tracked through a different auditable data store than the one that @@ -1242,24 +1242,24 @@ public function getCertificate($companyId, $id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient - * - * @param int $companyId The company ID to check - * @return \stdClass - */ - public function getCertificateSetup($companyId) { - $path = "/api/v2/companies/{$companyId}/certificates/setup"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Link attributes to a certificate - * + * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * Swagger Name: AvaTaxClient + * + * @param int $companyId The company ID to check + * @return \stdClass + */ + public function getCertificateSetup($companyId) { + $path = "/api/v2/companies/{$companyId}/certificates/setup"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Link attributes to a certificate + * * Link one or many attributes to a certificate. * * A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -1278,26 +1278,26 @@ public function getCertificateSetup($companyId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param CertificateAttributeModel[] $model The list of attributes to link to this certificate. - * @return \stdClass - */ - public function linkAttributesToCertificate($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes/link"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CertificateAttributeModel[] $model The list of attributes to link to this certificate. + * @return \stdClass + */ + public function linkAttributesToCertificate($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes/link"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Link customers to a certificate - * + } + + /** + * Link customers to a certificate + * * Link one or more customers to an existing certificate. * * Customers and certificates must be linked before a customer can make use of a certificate to obtain @@ -1317,26 +1317,26 @@ public function linkAttributesToCertificate($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param LinkCustomersModel $model The list of customers needed be added to the Certificate for exemption - * @return \stdClass - */ - public function linkCustomersToCertificate($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers/link"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LinkCustomersModel $model The list of customers needed be added to the Certificate for exemption + * @return \stdClass + */ + public function linkCustomersToCertificate($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers/link"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all attributes applied to this certificate - * + } + + /** + * List all attributes applied to this certificate + * * Retrieve the list of attributes that are linked to this certificate. * * A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -1355,25 +1355,25 @@ public function linkCustomersToCertificate($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function listAttributesForCertificate($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List customers linked to this certificate - * + * @param int $id The unique ID number of this certificate + * @return \stdClass + */ + public function listAttributesForCertificate($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List customers linked to this certificate + * * List all customers linked to this certificate. * * Customers must be linked to a certificate in order to make use of its tax exemption features. You @@ -1392,26 +1392,26 @@ public function listAttributesForCertificate($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param string $include OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. - * @return \stdClass - */ - public function listCustomersForCertificate($companyId, $id, $include=null) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all certificates for a company - * + * @param string $include OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. + * @return \stdClass + */ + public function listCustomersForCertificate($companyId, $id, $include=null) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all certificates for a company + * * List all certificates recorded by a company * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1433,29 +1433,29 @@ public function listCustomersForCertificate($companyId, $id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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. * @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryCertificates($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/certificates"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Request setup of exemption certificates for this company. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryCertificates($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/certificates"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Request setup of exemption certificates for this company. + * * Requests the setup of exemption certificates for this company. * * Exemption certificates are tracked through a different auditable data store than the one that @@ -1469,24 +1469,24 @@ public function queryCertificates($companyId, $include=null, $filter=null, $top= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient - * - * @param int $companyId - * @return \stdClass - */ - public function requestCertificateSetup($companyId) { - $path = "/api/v2/companies/{$companyId}/certificates/setup"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * * This API depends on the following active services:*Required* (all): AvaTaxPro. + * Swagger Name: AvaTaxClient + * + * @param int $companyId + * @return \stdClass + */ + public function requestCertificateSetup($companyId) { + $path = "/api/v2/companies/{$companyId}/certificates/setup"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Unlink attributes from a certificate - * + } + + /** + * Unlink attributes from a certificate + * * Unlink one or many attributes from a certificate. * * A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -1505,26 +1505,26 @@ public function requestCertificateSetup($companyId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param CertificateAttributeModel[] $model The list of attributes to unlink from this certificate. - * @return \stdClass - */ - public function unlinkAttributesFromCertificate($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes/unlink"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CertificateAttributeModel[] $model The list of attributes to unlink from this certificate. + * @return \stdClass + */ + public function unlinkAttributesFromCertificate($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes/unlink"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Unlink customers from a certificate - * + } + + /** + * Unlink customers from a certificate + * * Unlinks one or more customers from a certificate. * * Unlinking a certificate from a customer will prevent the certificate from being used to generate @@ -1545,26 +1545,26 @@ public function unlinkAttributesFromCertificate($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param LinkCustomersModel $model The list of customers to unlink from this certificate - * @return \stdClass - */ - public function unlinkCustomersFromCertificate($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers/unlink"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LinkCustomersModel $model The list of customers to unlink from this certificate + * @return \stdClass + */ + public function unlinkCustomersFromCertificate($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers/unlink"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single certificate - * + } + + /** + * Update a single certificate + * * Replace the certificate identified by this URL with a new one. * * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document @@ -1580,26 +1580,26 @@ public function unlinkCustomersFromCertificate($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param CertificateModel $model The new certificate object that will replace the existing one - * @return \stdClass - */ - public function updateCertificate($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CertificateModel $model The new certificate object that will replace the existing one + * @return \stdClass + */ + public function updateCertificate($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Upload an image or PDF attachment for this certificate - * + } + + /** + * Upload an image or PDF attachment for this certificate + * * Upload an image or PDF attachment for this certificate. * * Image attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please @@ -1618,26 +1618,26 @@ public function updateCertificate($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param object $file The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG. - * @return \stdClass - */ - public function uploadCertificateImage($companyId, $id, $file) { - $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attachment"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param object $file The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG. + * @return \stdClass + */ + public function uploadCertificateImage($companyId, $id, $file) { + $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attachment"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements. - * + } + + /** + * Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements. + * * Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations. * For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the * written integrations for a company are sufficient enough to be delivered to the respective customers to start using it. @@ -1664,24 +1664,24 @@ public function uploadCertificateImage($companyId, $id, $file) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass - */ - public function certifyIntegration($id) { - $path = "/api/v2/companies/{$id}/certify"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Change the filing status of this company - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass + */ + public function certifyIntegration($id) { + $path = "/api/v2/companies/{$id}/certify"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Change the filing status of this company + * * Changes the current filing status of this company. * * For customers using Avalara's Managed Returns Service, each company within their account can request @@ -1698,25 +1698,25 @@ public function certifyIntegration($id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * * @param int $id - * @param FilingStatusChangeModel $model - * @return \stdClass - */ - public function changeFilingStatus($id, $model) { - $path = "/api/v2/companies/{$id}/filingstatus"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param FilingStatusChangeModel $model + * @return \stdClass + */ + public function changeFilingStatus($id, $model) { + $path = "/api/v2/companies/{$id}/filingstatus"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Quick setup for a company with a single physical address - * + } + + /** + * Quick setup for a company with a single physical address + * * Shortcut to quickly setup a single-physical-location company with critical information and activate it. * This API provides quick and simple company setup functionality and does the following things: * @@ -1732,24 +1732,24 @@ public function changeFilingStatus($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient - * - * @param CompanyInitializationModel $model Information about the company you wish to create. - * @return \stdClass - */ - public function companyInitialize($model) { - $path = "/api/v2/companies/initialize"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient + * + * @param CompanyInitializationModel $model Information about the company you wish to create. + * @return \stdClass + */ + public function companyInitialize($model) { + $path = "/api/v2/companies/initialize"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create new companies - * + } + + /** + * Create new companies + * * Create one or more new company objects. * A 'company' represents a single corporation or individual that is registered to handle transactional taxes. * You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company. @@ -1758,24 +1758,24 @@ public function companyInitialize($model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass - */ - public function createCompanies($model) { - $path = "/api/v2/companies"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass + */ + public function createCompanies($model) { + $path = "/api/v2/companies"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Add parameters to a company. - * + } + + /** + * Add parameters to a company. + * * Add parameters to a company. * * Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". @@ -1790,25 +1790,25 @@ public function createCompanies($model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createCompanyParameters($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/parameters"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CompanyParameterDetailModel[] $model The company parameters you wish to create. + * @return \stdClass + */ + public function createCompanyParameters($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/parameters"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Request managed returns funding setup for a company - * + } + + /** + * Request managed returns funding setup for a company + * * This API is available by invitation only. * Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are * required to setup their funding configuration before Avalara can begin filing tax returns on their @@ -1823,49 +1823,49 @@ public function createCompanyParameters($companyId, $model) { * ### Security Policies * * * 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, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * * @param int $id The unique identifier of the company * @param string $businessUnit The company's business unit (See POABusinessUnit::* for a list of allowable values) * @param string $subscriptionType The company's subscription type (See POASubscriptionType::* for a list of allowable values) - * @param FundingInitiateModel $model The funding initialization request - * @return \stdClass - */ - public function createFundingRequest($id, $businessUnit, $subscriptionType, $model) { - $path = "/api/v2/companies/{$id}/funding/setup"; - $guzzleParams = [ - 'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType], - 'body' => json_encode($model) - ]; + * @param FundingInitiateModel $model The funding initialization request + * @return \stdClass + */ + public function createFundingRequest($id, $businessUnit, $subscriptionType, $model) { + $path = "/api/v2/companies/{$id}/funding/setup"; + $guzzleParams = [ + 'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single company - * + } + + /** + * Delete a single company + * * Deleting a company will delete all child companies, and all users attached to this company. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * - * @param int $id The ID of the company you wish to delete. - * @return \stdClass - */ - public function deleteCompany($id) { - $path = "/api/v2/companies/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the company you wish to delete. + * @return \stdClass + */ + public function deleteCompany($id) { + $path = "/api/v2/companies/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single company parameter - * + } + + /** + * Delete a single company parameter + * * Delete a parameter of a company. * Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". * @@ -1875,25 +1875,25 @@ public function deleteCompany($id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id - * @param int $id The parameter id - * @return \stdClass - */ - public function deleteCompanyParameter($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The parameter id + * @return \stdClass + */ + public function deleteCompanyParameter($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Check the funding configuration of a company - * + } + + /** + * Check the funding configuration of a company + * * This API is available by invitation only. * Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. * Returns the funding configuration of the requested company. @@ -1902,24 +1902,24 @@ public function deleteCompanyParameter($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass - */ - public function fundingConfigurationByCompany($companyId) { - $path = "/api/v2/companies/{$companyId}/funding/configuration"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Check the funding configuration of a company - * + * * 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 \stdClass + */ + public function fundingConfigurationByCompany($companyId) { + $path = "/api/v2/companies/{$companyId}/funding/configuration"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Check the funding configuration of a company + * * This API is available by invitation only. * Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. * Returns the funding configuration of the requested company. @@ -1928,25 +1928,25 @@ public function fundingConfigurationByCompany($companyId) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 + * * 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 - * @return \stdClass - */ - public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) { - $path = "/api/v2/companies/{$companyId}/funding/configurations"; - $guzzleParams = [ - 'query' => ['currency' => $currency], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single company - * + * @param string $currency The currency of the funding. USD and CAD are the only valid currencies + * @return \stdClass + */ + public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) { + $path = "/api/v2/companies/{$companyId}/funding/configurations"; + $guzzleParams = [ + 'query' => ['currency' => $currency], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single company + * * Get the company object identified by this URL. * A 'company' represents a single corporation or individual that is registered to handle transactional taxes. * You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values: @@ -1963,25 +1963,25 @@ public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. - * @return \stdClass - */ - public function getCompany($id, $include=null) { - $path = "/api/v2/companies/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get configuration settings for this company - * + * @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. + * @return \stdClass + */ + public function getCompany($id, $include=null) { + $path = "/api/v2/companies/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Get configuration settings for this company + * * Retrieve a list of all configuration settings tied to this company. * * Configuration settings provide you with the ability to control features of your account and of your @@ -1997,24 +1997,24 @@ public function getCompany($id, $include=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function getCompanyConfiguration($id) { - $path = "/api/v2/companies/{$id}/configuration"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single company parameter - * + * @param int $id + * @return \stdClass + */ + public function getCompanyConfiguration($id) { + $path = "/api/v2/companies/{$id}/configuration"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single company parameter + * * Retrieves a single parameter of a company. * * Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". @@ -2025,25 +2025,25 @@ public function getCompanyConfiguration($id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * * @param int $companyId - * @param int $id - * @return \stdClass - */ - public function getCompanyParameterDetail($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get this company's filing status - * + * @param int $id + * @return \stdClass + */ + public function getCompanyParameterDetail($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Get this company's filing status + * * Retrieve the current filing status of this company. * * For customers using Avalara's Managed Returns Service, each company within their account can request @@ -2061,24 +2061,24 @@ public function getCompanyParameterDetail($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function getFilingStatus($id) { - $path = "/api/v2/companies/{$id}/filingstatus"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get ACH entry detail report for company and period - * + * @param int $id + * @return \stdClass + */ + public function getFilingStatus($id) { + $path = "/api/v2/companies/{$id}/filingstatus"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Get ACH entry detail report for company and period + * * This API is available by invitation only. * Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. * Returns a list of ACH entry details for the given company and period. @@ -2087,26 +2087,26 @@ public function getFilingStatus($id) { * ### Security Policies * * * 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, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * * @param int $id The unique identifier of the company * @param int $periodyear The period year - * @param int $periodmonth The period month - * @return \stdClass - */ - public function listACHEntryDetailsForCompany($id, $periodyear, $periodmonth) { - $path = "/api/v2/companies/{$id}/paymentdetails/{$periodyear}/{$periodmonth}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve parameters for a company - * + * @param int $periodmonth The period month + * @return \stdClass + */ + public function listACHEntryDetailsForCompany($id, $periodyear, $periodmonth) { + $path = "/api/v2/companies/{$id}/paymentdetails/{$periodyear}/{$periodmonth}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve parameters for a company + * * Retrieve all parameters of a company. * * Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". @@ -2120,28 +2120,28 @@ public function listACHEntryDetailsForCompany($id, $periodyear, $periodmonth) * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCompanyParameterDetails($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/parameters"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Check managed returns funding status for a company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCompanyParameterDetails($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/parameters"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Check managed returns funding status for a company + * * This API is available by invitation only. * Requires a subscription to Avalara Managed Returns or SST Certified Service Provider. * Returns a list of funding setup requests and their current status. @@ -2150,47 +2150,47 @@ public function listCompanyParameterDetails($companyId, $filter=null, $top=null, * ### Security Policies * * * 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, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient - * - * @param int $id The unique identifier of the company - * @return \stdClass - */ - public function listFundingRequestsByCompany($id) { - $path = "/api/v2/companies/{$id}/funding"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a list of MRS Companies with account - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient + * + * @param int $id The unique identifier of the company + * @return \stdClass + */ + public function listFundingRequestsByCompany($id) { + $path = "/api/v2/companies/{$id}/funding"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a list of MRS Companies with account + * * This API is available by invitation only. * * Get a list of companies with an active MRS service. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient - * - * @return \stdClass - */ - public function listMrsCompanies() { - $path = "/api/v2/companies/mrs"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all companies - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient + * + * @return \stdClass + */ + public function listMrsCompanies() { + $path = "/api/v2/companies/mrs"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all companies + * * Get multiple company objects. * * A `company` represents a single corporation or individual that is registered to handle transactional taxes. @@ -2211,28 +2211,28 @@ public function listMrsCompanies() { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryCompanies($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Change configuration settings for this company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryCompanies($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Change configuration settings for this company + * * Update configuration settings tied to this company. * * Configuration settings provide you with the ability to control features of your account and of your @@ -2248,25 +2248,25 @@ public function queryCompanies($include=null, $filter=null, $top=null, $skip=nul * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $id - * @param CompanyConfigurationModel[] $model - * @return \stdClass - */ - public function setCompanyConfiguration($id, $model) { - $path = "/api/v2/companies/{$id}/configuration"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CompanyConfigurationModel[] $model + * @return \stdClass + */ + public function setCompanyConfiguration($id, $model) { + $path = "/api/v2/companies/{$id}/configuration"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single company - * + } + + /** + * Update a single company + * * Replace the existing company object at this URL with an updated object. * * A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes. @@ -2281,25 +2281,25 @@ public function setCompanyConfiguration($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function updateCompany($id, $model) { - $path = "/api/v2/companies/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CompanyModel $model The company object you wish to update. + * @return \stdClass + */ + public function updateCompany($id, $model) { + $path = "/api/v2/companies/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a company parameter - * + } + + /** + * Update a company parameter + * * Update a parameter of a company. * * Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters". @@ -2310,99 +2310,99 @@ public function updateCompany($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $id The company parameter id - * @param CompanyParameterDetailModel $model The company parameter object you wish to update. - * @return \stdClass - */ - public function updateCompanyParameterDetail($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CompanyParameterDetailModel $model The company parameter object you wish to update. + * @return \stdClass + */ + public function updateCompanyParameterDetail($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new contact - * + } + + /** + * Create a new contact + * * Create one or more new contact objects. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createContacts($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/contacts"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ContactModel[] $model The contacts you wish to create. + * @return \stdClass + */ + public function createContacts($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/contacts"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single contact - * + } + + /** + * Delete a single contact + * * Mark the existing contact object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteContact($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the contact you wish to delete. + * @return \stdClass + */ + public function deleteContact($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single contact - * + } + + /** + * Retrieve a single contact + * * Get the contact object identified by this URL. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function getContact($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve contacts for this company - * + * @param int $id The primary key of this contact + * @return \stdClass + */ + public function getContact($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve contacts for this company + * * List all contact objects assigned to this company. * * Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . @@ -2410,28 +2410,28 @@ public function getContact($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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/). * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listContactsByCompany($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/contacts"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all contacts - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listContactsByCompany($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/contacts"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all contacts + * * Get multiple contact objects across all companies. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. @@ -2441,27 +2441,27 @@ public function listContactsByCompany($companyId, $filter=null, $top=null, $skip * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryContacts($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/contacts"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single contact - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryContacts($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/contacts"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single contact + * * Replace the existing contact object at this URL with an updated object. * A 'contact' is a person associated with a company who is designated to handle certain responsibilities of * a tax collecting and filing entity. @@ -2470,26 +2470,26 @@ public function queryContacts($filter=null, $top=null, $skip=null, $orderBy=null * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param ContactModel $model The contact you wish to update. - * @return \stdClass - */ - public function updateContact($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ContactModel $model The contact you wish to update. + * @return \stdClass + */ + public function updateContact($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create customers for this company - * + } + + /** + * Create customers for this company + * * Create one or more customers for this company. * * A customer object defines information about a person or business that purchases products from your @@ -2509,25 +2509,25 @@ public function updateContact($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function createCustomers($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/customers"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CustomerModel[] $model The list of customer objects to be created + * @return \stdClass + */ + public function createCustomers($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/customers"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a customer record - * + } + + /** + * Delete a customer record + * * Deletes the customer object referenced by this URL. * * A customer object defines information about a person or business that purchases products from your @@ -2544,25 +2544,25 @@ public function createCustomers($companyId, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function deleteCustomer($companyId, $customerCode) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param string $customerCode The unique code representing this customer + * @return \stdClass + */ + public function deleteCustomer($companyId, $customerCode) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single customer - * + } + + /** + * Retrieve a single customer + * * Retrieve the customer identified by this URL. * * A customer object defines information about a person or business that purchases products from your @@ -2585,26 +2585,26 @@ public function deleteCustomer($companyId, $customerCode) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param string $include Specify optional additional objects to include in this fetch request - * @return \stdClass - */ - public function getCustomer($companyId, $customerCode, $include=null) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Link attributes to a customer - * + * @param string $include Specify optional additional objects to include in this fetch request + * @return \stdClass + */ + public function getCustomer($companyId, $customerCode, $include=null) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Link attributes to a customer + * * Link one or many attributes to a customer. * * A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -2624,26 +2624,26 @@ public function getCustomer($companyId, $customerCode, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param CustomerAttributeModel[] $model The list of attributes to link to the customer. - * @return \stdClass - */ - public function linkAttributesToCustomer($companyId, $customerCode, $model) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes/link"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CustomerAttributeModel[] $model The list of attributes to link to the customer. + * @return \stdClass + */ + public function linkAttributesToCustomer($companyId, $customerCode, $model) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes/link"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Link certificates to a customer - * + } + + /** + * Link certificates to a customer + * * Link one or more certificates to a customer. * * A customer object defines information about a person or business that purchases products from your @@ -2660,26 +2660,26 @@ public function linkAttributesToCustomer($companyId, $customerCode, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param LinkCertificatesModel $model The list of certificates to link to this customer - * @return \stdClass - */ - public function linkCertificatesToCustomer($companyId, $customerCode, $model) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/link"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LinkCertificatesModel $model The list of certificates to link to this customer + * @return \stdClass + */ + public function linkCertificatesToCustomer($companyId, $customerCode, $model) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/link"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Link two customer records together - * + } + + /** + * Link two customer records together + * * Links a Ship-To customer record with a Bill-To customer record. * * Customer records represent businesses or individuals who can provide exemption certificates. Some customers @@ -2697,26 +2697,26 @@ public function linkCertificatesToCustomer($companyId, $customerCode, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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. - * @param LinkCustomersModel $model A list of information about ship-to customers to link to this bill-to customer. - * @return \stdClass - */ - public function linkShipToCustomersToBillCustomer($companyId, $code, $model) { - $path = "/api/v2/companies/{$companyId}/customers/billto/{$code}/shipto/link"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LinkCustomersModel $model A list of information about ship-to customers to link to this bill-to customer. + * @return \stdClass + */ + public function linkShipToCustomersToBillCustomer($companyId, $code, $model) { + $path = "/api/v2/companies/{$companyId}/customers/billto/{$code}/shipto/link"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a customer's attributes - * + } + + /** + * Retrieve a customer's attributes + * * Retrieve the attributes linked to the customer identified by this URL. * * A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -2736,25 +2736,25 @@ public function linkShipToCustomersToBillCustomer($companyId, $code, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function listAttributesForCustomer($companyId, $customerCode) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List certificates linked to a customer - * + * @param string $customerCode The unique code representing the current customer + * @return \stdClass + */ + public function listAttributesForCustomer($companyId, $customerCode) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List certificates linked to a customer + * * List all certificates linked to a customer. * * A customer object defines information about a person or business that purchases products from your @@ -2771,8 +2771,8 @@ public function listAttributesForCustomer($companyId, $customerCode) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 @@ -2780,21 +2780,21 @@ public function listAttributesForCustomer($companyId, $customerCode) { * @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:* exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCertificatesForCustomer($companyId, $customerCode, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List valid certificates for a location - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCertificatesForCustomer($companyId, $customerCode, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List valid certificates for a location + * * List valid certificates linked to a customer in a particular country and region. * * This API is intended to help identify whether a customer has already provided a certificate that @@ -2814,27 +2814,27 @@ public function listCertificatesForCustomer($companyId, $customerCode, $include= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 * @param string $country Search for certificates matching this country. Uses the ISO 3166 two character country code. - * @param string $region Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code. - * @return \stdClass - */ - public function listValidCertificatesForCustomer($companyId, $customerCode, $country, $region) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/{$country}/{$region}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all customers for this company - * + * @param string $region Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code. + * @return \stdClass + */ + public function listValidCertificatesForCustomer($companyId, $customerCode, $country, $region) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/{$country}/{$region}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all customers for this company + * * List all customers recorded by this company matching the specified criteria. * * A customer object defines information about a person or business that purchases products from your @@ -2856,29 +2856,29 @@ public function listValidCertificatesForCustomer($companyId, $customerCode, $cou * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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. * @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:* shipTos * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryCustomers($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/customers"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Unlink attributes from a customer - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryCustomers($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/customers"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Unlink attributes from a customer + * * Unlink one or many attributes from a customer. * * A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a @@ -2898,26 +2898,26 @@ public function queryCustomers($companyId, $include=null, $filter=null, $top=nul * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param CustomerAttributeModel[] $model The list of attributes to unlink from the customer. - * @return \stdClass - */ - public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes/unlink"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CustomerAttributeModel[] $model The list of attributes to unlink from the customer. + * @return \stdClass + */ + public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes/unlink"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Unlink certificates from a customer - * + } + + /** + * Unlink certificates from a customer + * * Remove one or more certificates to a customer. * * A customer object defines information about a person or business that purchases products from your @@ -2934,26 +2934,26 @@ public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param LinkCertificatesModel $model The list of certificates to link to this customer - * @return \stdClass - */ - public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/unlink"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LinkCertificatesModel $model The list of certificates to link to this customer + * @return \stdClass + */ + public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/unlink"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single customer - * + } + + /** + * Update a single customer + * * Replace the customer object at this URL with a new record. * * A customer object defines information about a person or business that purchases products from your @@ -2970,125 +2970,125 @@ public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @param CustomerModel $model The new customer model that will replace the existing record at this URL - * @return \stdClass - */ - public function updateCustomer($companyId, $customerCode, $model) { - $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CustomerModel $model The new customer model that will replace the existing record at this URL + * @return \stdClass + */ + public function updateCustomer($companyId, $customerCode, $model) { + $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create and store new datasources for the respective companies. - * + } + + /** + * Create and store new datasources for the respective companies. + * * Create one or more datasource objects. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function createDataSources($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/datasources"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param DataSourceModel[] $model + * @return \stdClass + */ + public function createDataSources($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/datasources"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a datasource by datasource id for a company. - * + } + + /** + * Delete a datasource by datasource id for a company. + * * Marks the existing datasource for a company as deleted. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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. - * @return \stdClass - */ - public function deleteDataSource($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The id of the datasource you wish to delete. + * @return \stdClass + */ + public function deleteDataSource($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get data source by data source id - * + } + + /** + * Get data source by data source id + * * Retrieve the data source by its unique ID number. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + * Swagger Name: AvaTaxClient * * @param int $companyId - * @param int $id data source id - * @return \stdClass - */ - public function getDataSourceById($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all datasources for this company - * + * @param int $id data source id + * @return \stdClass + */ + public function getDataSourceById($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all datasources for this company + * * Gets multiple datasource objects for a given company. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 + * * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listDataSources($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/datasources"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all datasources - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listDataSources($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/datasources"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all datasources + * * Get multiple datasource objects across all companies. * * Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) . @@ -3097,52 +3097,52 @@ public function listDataSources($companyId, $filter=null, $top=null, $skip=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 + * * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryDataSources($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/datasources"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a datasource identified by id for a company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryDataSources($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/datasources"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a datasource identified by id for a company + * * Updates a datasource for a company. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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. - * @param DataSourceModel $model - * @return \stdClass - */ - public function updateDataSource($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param DataSourceModel $model + * @return \stdClass + */ + public function updateDataSource($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Lists all parents of an HS Code. - * + } + + /** + * Lists all parents of an HS Code. + * * Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings * * a list of HS Codes that are the parents and information branches of the HS Code for the given @@ -3156,289 +3156,289 @@ public function updateDataSource($companyId, $id, $model) { * * ### Security Policies * - * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. - * Swagger Name: AvaTaxClient + * * 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. - * @return \stdClass - */ - public function getCrossBorderCode($country, $hsCode) { - $path = "/api/v2/definitions/crossborder/{$country}/{$hsCode}/hierarchy"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Test whether a form supports online login verification - * + * @param string $hsCode The partial or full HS Code for which you would like to view all of the parents. + * @return \stdClass + */ + public function getCrossBorderCode($country, $hsCode) { + $path = "/api/v2/definitions/crossborder/{$country}/{$hsCode}/hierarchy"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Test whether a form supports online login verification + * * 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 + * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function getLoginVerifierByForm($form, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/filingcalendars/loginverifiers/{$form}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all market place locations. - * - * List all market place locations. - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function getLoginVerifierByForm($form, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/filingcalendars/loginverifiers/{$form}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listAllMarketplaceLocations($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/listallmarketplacelocations"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of the AvaFile Forms available - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listAllMarketplaceLocations($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/listallmarketplacelocations"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of the AvaFile Forms available + * * This API is deprecated. * * Please use the ListTaxForms API. * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/avafileforms"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List certificate attributes used by a company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/avafileforms"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List certificate attributes used by a company + * * List the certificate attributes defined by a company either specified by the user or the user's default company. * * A certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a * certificate at any time. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * Swagger Name: AvaTaxClient + * 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/). * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCertificateAttributes($companyid, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/certificateattributes"; - $guzzleParams = [ - 'query' => ['companyid' => $companyid, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List the certificate exempt reasons defined by a company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCertificateAttributes($companyid, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/certificateattributes"; + $guzzleParams = [ + 'query' => ['companyid' => $companyid, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List the certificate exempt reasons defined by a company + * * List the certificate exempt reasons defined by a company. * * An exemption reason defines why a certificate allows a customer to be exempt * for purposes of tax calculation. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * Swagger Name: AvaTaxClient + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCertificateExemptReasons($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/certificateexemptreasons"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List certificate exposure zones used by a company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCertificateExemptReasons($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/certificateexemptreasons"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List certificate exposure zones used by a company + * * List the certificate exposure zones defined by a company. * * An exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing * authority or other legal entity to which a certificate may apply. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * Swagger Name: AvaTaxClient + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCertificateExposureZones($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/certificateexposurezones"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCertificateExposureZones($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/certificateexposurezones"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listClassificationParametersUsage($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/classification/parametersusage"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of communications service types - * - * Returns full list of service types for a given transaction type ID. - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listClassificationParametersUsage($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/classification/parametersusage"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCommunicationsServiceTypes($id, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/communications/transactiontypes/{$id}/servicetypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of communications transactiontypes - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCommunicationsServiceTypes($id, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/communications/transactiontypes/{$id}/servicetypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of communications transactiontypes + * * Returns full list of communications transaction types which - * are accepted in communication tax calculation requests. - * Swagger Name: AvaTaxClient + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCommunicationsTransactionTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/communications/transactiontypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of communications transaction/service type pairs - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCommunicationsTransactionTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/communications/transactiontypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of communications transaction/service type pairs + * * Returns full list of communications transaction/service type pairs which - * are accepted in communication tax calculation requests. - * Swagger Name: AvaTaxClient + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCommunicationsTSPairs($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/communications/tspairs"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all ISO 3166 countries - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCommunicationsTSPairs($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/communications/tspairs"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all ISO 3166 countries + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCountries($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/countries"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List certificate exposure zones used by a company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCountries($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/countries"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List certificate exposure zones used by a company + * * List available cover letters that can be used when sending invitation to use CertExpress to upload certificates. * * The CoverLetter model represents a message sent along with an invitation to use CertExpress to @@ -3446,27 +3446,27 @@ public function listCountries($filter=null, $top=null, $skip=null, $orderBy=null * certificates directly; this cover letter explains why the invitation was sent. * * If you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to - * check and provision account. - * Swagger Name: AvaTaxClient + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCoverLetters($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/coverletters"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Lists the next level of HS Codes given a destination country and HS Code prefix. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCoverLetters($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/coverletters"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Lists the next level of HS Codes given a destination country and HS Code prefix. + * * Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if * additional children are available. * @@ -3478,29 +3478,29 @@ 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 + * * 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. * @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:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCrossBorderCodes($country, $hsCode, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/crossborder/{$country}/{$hsCode}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List top level HS Code Sections. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCrossBorderCodes($country, $hsCode, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/crossborder/{$country}/{$hsCode}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List top level HS Code Sections. + * * Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for * classifying tariff codes and the items to which they apply. HS Codes are organized * by Section/Chapter/Heading/Subheading/Classification. @@ -3510,128 +3510,128 @@ 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 \stdClass - */ - public function listCrossBorderSections() { - $path = "/api/v2/definitions/crossborder/sections"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all ISO 4217 currencies supported by AvaTax. - * + * * This API depends on the following active services:*Required* (all): AvaTaxGlobal. + * Swagger Name: AvaTaxClient + * + * @return \stdClass + */ + public function listCrossBorderSections() { + $path = "/api/v2/definitions/crossborder/sections"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all ISO 4217 currencies supported by AvaTax. + * * Lists all ISO 4217 currencies supported by AvaTax. * * 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 + * `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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listCurrencies($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/currencies"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported entity use codes - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listCurrencies($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/currencies"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported entity use codes + * * Returns the full list of Avalara-supported entity use codes. * Entity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listEntityUseCodes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/entityusecodes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported filing frequencies. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listEntityUseCodes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/entityusecodes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported filing frequencies. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/filingfrequencies"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List jurisdictions based on the filter provided - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/filingfrequencies"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List jurisdictions based on the filter provided + * * Returns a list of all Avalara-supported taxing jurisdictions. * * This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying * 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 + * The rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API. + * Swagger Name: AvaTaxClient * * @param string $filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* rate, salesRate, signatureCode, useRate, isAcm, isSst * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listJurisdictions($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/jurisdictions"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List jurisdictions near a specific address - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listJurisdictions($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/jurisdictions"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List jurisdictions near a specific address + * * Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. * * This API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information. * It is intended to allow you to create a "Jurisdiction Override", which allows an address to be configured as belonging to a nearby * jurisdiction in AvaTax. * - * The results of this API call can be passed to the `CreateJurisdictionOverride` API call. - * Swagger Name: AvaTaxClient + * 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. @@ -3643,21 +3643,21 @@ public function listJurisdictions($filter=null, $top=null, $skip=null, $orderBy= * @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 int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/jurisdictionsnearaddress"; - $guzzleParams = [ - '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, AVATAX_SDK_VERSION ); - } - - /** - * List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/jurisdictionsnearaddress"; + $guzzleParams = [ + '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, AVATAX_SDK_VERSION ); + } + + /** + * List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId + * * Returns a list of all Avalara-supported taxing jurisdictions filtered by taxTypeId, taxSubTypeId, country, and rateTypeId. * * You can optionally pass region as a query parameter to retrieve jurisdictions that are under that region. @@ -3665,8 +3665,8 @@ public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $regio * This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying * 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 + * 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 $taxTypeId The taxtype for which you want to retrieve the jurisdiction information @@ -3676,49 +3676,49 @@ public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $regio * @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, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId, stateFips * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listJurisdictionsByRateTypeTaxTypeMapping($country, $taxTypeId, $taxSubTypeId, $rateTypeId, $region, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/jurisdictions/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}"; - $guzzleParams = [ - 'query' => ['rateTypeId' => $rateTypeId, 'region' => $region, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId - * - * Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listJurisdictionsByRateTypeTaxTypeMapping($country, $taxTypeId, $taxSubTypeId, $rateTypeId, $region, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/jurisdictions/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}"; + $guzzleParams = [ + 'query' => ['rateTypeId' => $rateTypeId, 'region' => $region, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId + * + * Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId + * Swagger Name: AvaTaxClient * * @param string $country The country for which you want to retrieve the jurisdiction information * @param string $taxTypeId The taxtype for which you want to retrieve the jurisdiction information * @param string $taxSubTypeId The taxsubtype for which you want to retrieve the jurisdiction information - * @param string $rateTypeId The ratetype for which you want to retrieve the jurisdiction information - * @return \stdClass - */ - public function listJurisdictionTypesByRateTypeTaxTypeMapping($country, $taxTypeId, $taxSubTypeId, $rateTypeId) { - $path = "/api/v2/definitions/jurisdictionTypes/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}"; - $guzzleParams = [ - 'query' => ['rateTypeId' => $rateTypeId], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list of questions that are required for a tax location - * + * @param string $rateTypeId The ratetype for which you want to retrieve the jurisdiction information + * @return \stdClass + */ + public function listJurisdictionTypesByRateTypeTaxTypeMapping($country, $taxTypeId, $taxSubTypeId, $rateTypeId) { + $path = "/api/v2/definitions/jurisdictionTypes/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}"; + $guzzleParams = [ + 'query' => ['rateTypeId' => $rateTypeId], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the list of questions that are required for a tax location + * * Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions. * Some tax jurisdictions require that you register or provide additional information to configure each physical place where * your company does business. * 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 + * 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. @@ -3732,94 +3732,94 @@ public function listJurisdictionTypesByRateTypeTaxTypeMapping($country, $taxType * @param string $filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listLocationQuestionsByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $latitude, $longitude, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/locationquestions"; - $guzzleParams = [ - '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, AVATAX_SDK_VERSION ); - } - - /** - * List all forms where logins can be verified automatically - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listLocationQuestionsByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $latitude, $longitude, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/locationquestions"; + $guzzleParams = [ + '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, AVATAX_SDK_VERSION ); + } + + /** + * List all forms where logins can be verified automatically + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listLoginVerifiers($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/filingcalendars/loginverifiers"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list of locations for a marketplace. - * - * Retrieves the list of suggested locations for a marketplace. - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listLoginVerifiers($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/filingcalendars/loginverifiers"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listMarketplaceLocations($marketplaceId, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/marketplacelocations"; - $guzzleParams = [ - 'query' => ['marketplaceId' => $marketplaceId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported nexus for all countries and regions. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listMarketplaceLocations($marketplaceId, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/marketplacelocations"; + $guzzleParams = [ + 'query' => ['marketplaceId' => $marketplaceId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported nexus for all countries and regions. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexus($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/nexus"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all nexus that apply to a specific address. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexus($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/nexus"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all nexus that apply to a specific address. + * * Returns a list of all Avalara-supported taxing jurisdictions that apply to this address. * This API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale. * 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 + * 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. @@ -3831,70 +3831,70 @@ public function listNexus($filter=null, $top=null, $skip=null, $orderBy=null) * @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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/nexus/byaddress"; - $guzzleParams = [ - '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, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported nexus for a country. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/nexus/byaddress"; + $guzzleParams = [ + '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, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported nexus for a country. + * * 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 + * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/nexus/{$country}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported nexus for a country and region. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/nexus/{$country}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported nexus for a country and region. + * * 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 + * 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. * @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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusByCountryAndRegion($country, $region, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/nexus/{$country}/{$region}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List nexus related to a tax form - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusByCountryAndRegion($country, $region, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/nexus/{$country}/{$region}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List nexus related to a tax form + * * Retrieves a list of nexus related to a tax form. * * The concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated @@ -3909,313 +3909,313 @@ public function listNexusByCountryAndRegion($country, $region, $filter=null, $to * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 \stdClass - */ - public function listNexusByFormCode($formCode) { - $path = "/api/v2/definitions/nexus/byform/{$formCode}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported nexus for a tax type group. - * + * @param string $formCode The form code that we are looking up the nexus for + * @return \stdClass + */ + public function listNexusByFormCode($formCode) { + $path = "/api/v2/definitions/nexus/byform/{$formCode}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported nexus for a tax type group. + * * 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 + * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusByTaxTypeGroup($taxTypeGroup, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/nexus/bytaxtypegroup/{$taxTypeGroup}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of nexus tax type groups - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusByTaxTypeGroup($taxTypeGroup, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/nexus/bytaxtypegroup/{$taxTypeGroup}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of nexus tax type groups + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusTaxTypeGroups($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/nexustaxtypegroups"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice customer funding options. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusTaxTypeGroups($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/nexustaxtypegroups"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice customer funding options. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeCustomerFundingOptions($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticecustomerfundingoptions"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice customer types. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeCustomerFundingOptions($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticecustomerfundingoptions"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice customer types. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeCustomerTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticecustomertypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice filing types. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeCustomerTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticecustomertypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice filing types. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeFilingtypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticefilingtypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice priorities. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeFilingtypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticefilingtypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice priorities. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticePriorities($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticepriorities"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice reasons. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticePriorities($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticepriorities"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice reasons. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeReasons($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticereasons"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice responsibility ids - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeReasons($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticereasons"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice responsibility ids + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeResponsibilities($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticeresponsibilities"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice root causes - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeResponsibilities($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticeresponsibilities"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice root causes + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeRootCauses($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticerootcauses"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice statuses. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeRootCauses($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticerootcauses"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice statuses. + * * 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 + * 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, activeFlag * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeStatuses($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticestatuses"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax notice types. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeStatuses($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticestatuses"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax notice types. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNoticeTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/noticetypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported extra parameters for creating transactions. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNoticeTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/noticetypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported extra parameters for creating transactions. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listParameters($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/parameters"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list of Avalara-supported parameters based on account subscriptions. - * - * Returns the list of Avalara-supported parameters based on account subscriptions. - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listParameters($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/parameters"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the list of Avalara-supported parameters based on account subscriptions. + * + * Returns the list of Avalara-supported parameters based on account subscriptions. + * Swagger Name: AvaTaxClient * * @param int $accountId The ID of the account to retrieve the parameters. * @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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listParametersByAccount($accountId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/accounts/{$accountId}/parameters"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the parameters by companyCode and itemCode. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listParametersByAccount($accountId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/accounts/{$accountId}/parameters"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the parameters by companyCode and itemCode. + * * Returns the list of parameters based on the company's service types and the item code. * Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section. * Ignores nexus for the AvaAlcohol service type. @@ -4233,94 +4233,94 @@ public function listParametersByAccount($accountId, $filter=null, $top=null, $sk * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient * * @param string $companyCode Company code. * @param string $itemCode Item 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:* 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listParametersByItem($companyCode, $itemCode, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/parameters/byitem/{$companyCode}/{$itemCode}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listParametersByItem($companyCode, $itemCode, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/parameters/byitem/{$companyCode}/{$itemCode}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listParametersUsage($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/parametersusage"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported permissions - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listParametersUsage($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/parametersusage"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported permissions + * * 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 + * 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. - * @return \stdClass - */ - public function listPermissions($top=null, $skip=null) { - $path = "/api/v2/definitions/permissions"; - $guzzleParams = [ - 'query' => ['$top' => $top, '$skip' => $skip], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported postal codes. - * - * Retrieves the list of Avalara-supported postal codes. - * Swagger Name: AvaTaxClient + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @return \stdClass + */ + public function listPermissions($top=null, $skip=null) { + $path = "/api/v2/definitions/permissions"; + $guzzleParams = [ + 'query' => ['$top' => $top, '$skip' => $skip], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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. * @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`. - * @param boolean $includeExpiredPostalCodes If set to true, returns expired postal codes. Defaults to false - * @return \stdClass - */ - public function listPostalCodes($filter=null, $top=null, $skip=null, $orderBy=null, $includeExpiredPostalCodes=null) { - $path = "/api/v2/definitions/postalcodes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, 'includeExpiredPostalCodes' => null === $includeExpiredPostalCodes ? null : json_encode($includeExpiredPostalCodes)], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all customs duty programs recognized by AvaTax - * + * @param boolean $includeExpiredPostalCodes If set to true, returns expired postal codes. Defaults to false + * @return \stdClass + */ + public function listPostalCodes($filter=null, $top=null, $skip=null, $orderBy=null, $includeExpiredPostalCodes=null) { + $path = "/api/v2/definitions/postalcodes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, 'includeExpiredPostalCodes' => null === $includeExpiredPostalCodes ? null : json_encode($includeExpiredPostalCodes)], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all customs duty programs recognized by AvaTax + * * List all preferred customs duty programs recognized by AvaTax. * * A customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents. @@ -4329,52 +4329,52 @@ 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listPreferredPrograms($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/preferredprograms"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all available product classification systems. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listPreferredPrograms($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/preferredprograms"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all available product classification systems. + * * List all available product classification systems. * * 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 + * 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. * @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`. - * @param string $countryCode If not null, return all records with this code. - * @return \stdClass - */ - public function listProductClassificationSystems($filter=null, $top=null, $skip=null, $orderBy=null, $countryCode=null) { - $path = "/api/v2/definitions/productclassificationsystems"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all product classification systems available to a company based on its nexus. - * + * @param string $countryCode If not null, return all records with this code. + * @return \stdClass + */ + public function listProductClassificationSystems($filter=null, $top=null, $skip=null, $orderBy=null, $countryCode=null) { + $path = "/api/v2/definitions/productclassificationsystems"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all product classification systems available to a company based on its nexus. + * * Lists all product classification systems available to a company based on its nexus. * * Tax authorities use product classification systems as a way to identify products and associate them with a tax rate. @@ -4386,55 +4386,55 @@ public function listProductClassificationSystems($filter=null, $top=null, $skip= * * Replace '+' with '\_-ava2b-\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code' * * 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 + * * 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 * @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`. - * @param string $countryCode If not null, return all records with this code. - * @return \stdClass - */ - public function listProductClassificationSystemsByCompany($companyCode, $filter=null, $top=null, $skip=null, $orderBy=null, $countryCode=null) { - $path = "/api/v2/definitions/productclassificationsystems/bycompany/{$companyCode}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of rate types for each country - * + * @param string $countryCode If not null, return all records with this code. + * @return \stdClass + */ + public function listProductClassificationSystemsByCompany($companyCode, $filter=null, $top=null, $skip=null, $orderBy=null, $countryCode=null) { + $path = "/api/v2/definitions/productclassificationsystems/bycompany/{$companyCode}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of rate types for each country + * * 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 + * 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/). * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listRateTypesByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/countries/{$country}/ratetypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list of rate types by country, TaxType and by TaxSubType - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listRateTypesByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/countries/{$country}/ratetypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the list of rate types by country, TaxType and by TaxSubType + * * 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 + * 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 @@ -4442,72 +4442,72 @@ public function listRateTypesByCountry($country, $filter=null, $top=null, $skip= * @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, rateType, description * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listRateTypesByCountryTaxTypeTaxSubType($country, $taxTypeId, $taxSubTypeId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}/ratetypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all ISO 3166 regions - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listRateTypesByCountryTaxTypeTaxSubType($country, $taxTypeId, $taxSubTypeId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}/ratetypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all ISO 3166 regions + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listRegions($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/regions"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all ISO 3166 regions for a country - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listRegions($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/regions"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all ISO 3166 regions for a country + * * 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 + * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listRegionsByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/countries/{$country}/regions"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list of applicable regions by country tax type, tax sub type, and rate type for a given JurisdictionTypeId - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listRegionsByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/countries/{$country}/regions"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the list of applicable regions by country tax type, tax sub type, and rate type for a given JurisdictionTypeId + * * 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 used as a way to provide a dropdown box in your website to allow customers to select a region - * within the country for shipping addresses. - * Swagger Name: AvaTaxClient + * within the country for shipping addresses. + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company for which you want to retrieve the applicable regions * @param string $country The country for which you want to retrieve the regions @@ -4517,202 +4517,202 @@ public function listRegionsByCountry($country, $filter=null, $top=null, $skip=nu * @param string $jurisdictionTypeId The JurisdictionTypeId for which you want to retrieve the regions. This is a three-character string. Accepted values are ```CNT``` (country), ```STA``` (state), ```CTY``` (county), ```CIT``` (city), or ```STJ``` (special 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 \stdClass - */ - public function listRegionsByCountryAndTaxTypeAndTaxSubTypeAndRateType($companyId, $country, $taxTypeId, $taxSubTypeId, $rateTypeId, $jurisdictionTypeId, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/companies/{$companyId}/countries/{$country}/regions/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}/rateTypeId/{$rateTypeId}/jurisdictionTypeId/{$jurisdictionTypeId}"; - $guzzleParams = [ - 'query' => ['$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported resource file types - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listRegionsByCountryAndTaxTypeAndTaxSubTypeAndRateType($companyId, $country, $taxTypeId, $taxSubTypeId, $rateTypeId, $jurisdictionTypeId, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/companies/{$companyId}/countries/{$country}/regions/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}/rateTypeId/{$rateTypeId}/jurisdictionTypeId/{$jurisdictionTypeId}"; + $guzzleParams = [ + 'query' => ['$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported resource file types + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listResourceFileTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/resourcefiletypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported usage of parameters used for returns. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listResourceFileTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/resourcefiletypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported usage of parameters used for returns. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listReturnsParametersUsage($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/returns/parametersusage"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported permissions - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listReturnsParametersUsage($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/returns/parametersusage"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported permissions + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listSecurityRoles($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/securityroles"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported subscription types - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listSecurityRoles($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/securityroles"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported subscription types + * * Returns the full list of Avalara-supported subscription types. * 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 + * 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/).
*Not filterable:* taxTypeGroupIdSK * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listSubscriptionTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/subscriptiontypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list all tags supported by avalara - * - * Retrieves the list of suggested locations for a marketplace. - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listSubscriptionTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/subscriptiontypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTags($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/tags"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax authorities. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTags($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/tags"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax authorities. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxAuthorities($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxauthorities"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported forms for each tax authority. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxAuthorities($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxauthorities"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported forms for each tax authority. + * * Returns the full list of Avalara-supported forms for each tax authority. * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxAuthorityForms($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxauthorityforms"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax authority types. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxAuthorityForms($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxauthorityforms"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax authority types. + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxAuthorityTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxauthoritytypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax codes. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxAuthorityTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxauthoritytypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax codes. + * * Retrieves the list of Avalara-supported system tax codes. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -4721,95 +4721,95 @@ public function listTaxAuthorityTypes($filter=null, $top=null, $skip=null, $orde * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxCodes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxcodes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported tax code types. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxCodes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxcodes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of Avalara-supported tax code types. + * * 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 + * 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. - * @return \stdClass - */ - public function listTaxCodeTypes($top=null, $skip=null) { - $path = "/api/v2/definitions/taxcodetypes"; - $guzzleParams = [ - 'query' => ['$top' => $top, '$skip' => $skip], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of the Tax Forms available - * + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @return \stdClass + */ + public function listTaxCodeTypes($top=null, $skip=null) { + $path = "/api/v2/definitions/taxcodetypes"; + $guzzleParams = [ + 'query' => ['$top' => $top, '$skip' => $skip], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of the Tax Forms available + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxForms($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxforms"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of tax sub types - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxForms($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxforms"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of tax sub types + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxSubTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxsubtypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of tax sub types by Country and TaxType - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxSubTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxsubtypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of tax sub types by Country and TaxType + * * 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 + * 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 @@ -4817,91 +4817,91 @@ public function listTaxSubTypes($filter=null, $top=null, $skip=null, $orderBy=nu * @param string $filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxSubTypesByCountryAndTaxType($country, $taxTypeId, $companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxsubtypes/countries/{$country}/taxtypes/{$taxTypeId}"; - $guzzleParams = [ - 'query' => ['companyId' => $companyId, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of tax sub types by jurisdiction code and region - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxSubTypesByCountryAndTaxType($country, $taxTypeId, $companyId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxsubtypes/countries/{$country}/taxtypes/{$taxTypeId}"; + $guzzleParams = [ + 'query' => ['companyId' => $companyId, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of tax sub types by jurisdiction code and region + * * 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 + * 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. * @param string $filter A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/). * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxSubTypesByJurisdictionAndRegion($jurisdictionCode, $region, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxsubtypes/{$jurisdictionCode}/{$region}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of tax type groups - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxSubTypesByJurisdictionAndRegion($jurisdictionCode, $region, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxsubtypes/{$jurisdictionCode}/{$region}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve the full list of tax type groups + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxTypeGroups($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxtypegroups"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list of applicable TaxTypes - * - * Retrieves the list of applicable TaxTypes based on Nexus of the company. - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxTypeGroups($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxtypegroups"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxTypesByNexusAndCountry($country, $companyId, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/taxtypes/countries/{$country}"; - $guzzleParams = [ - 'query' => ['companyId' => $companyId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the list of applicable UnitOfBasis - * - * Retrieves the list of applicable UnitOfBasis - * Swagger Name: AvaTaxClient + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxTypesByNexusAndCountry($country, $companyId, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/taxtypes/countries/{$country}"; + $guzzleParams = [ + 'query' => ['companyId' => $companyId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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 @@ -4909,44 +4909,44 @@ public function listTaxTypesByNexusAndCountry($country, $companyId, $top=null, $ * @param string $rateTypeId The ratetype for which you want to retrieve the unitofbasis information * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType($country, $taxTypeId, $taxSubTypeId, $rateTypeId, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/unitofbasis/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}"; - $guzzleParams = [ - 'query' => ['rateTypeId' => $rateTypeId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all defined units of measurement - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType($country, $taxTypeId, $taxSubTypeId, $rateTypeId, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/unitofbasis/countries/{$country}/taxtypes/{$taxTypeId}/taxsubtypes/{$taxSubTypeId}"; + $guzzleParams = [ + 'query' => ['rateTypeId' => $rateTypeId, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all defined units of measurement + * * 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 + * 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listUnitOfMeasurement($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/definitions/unitofmeasurements"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create one or more DistanceThreshold objects - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listUnitOfMeasurement($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/definitions/unitofmeasurements"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create one or more DistanceThreshold objects + * * Create one or more DistanceThreshold objects for this company. * * A company-distance-threshold model indicates the distance between a company @@ -4955,25 +4955,25 @@ public function listUnitOfMeasurement($filter=null, $top=null, $skip=null, $orde * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createDistanceThreshold($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/distancethresholds"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CompanyDistanceThresholdModel[] $model The DistanceThreshold object or objects you wish to create. + * @return \stdClass + */ + public function createDistanceThreshold($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/distancethresholds"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single DistanceThreshold object - * + } + + /** + * Delete a single DistanceThreshold object + * * Marks the DistanceThreshold object identified by this URL as deleted. * * A company-distance-threshold model indicates the distance between a company @@ -4982,25 +4982,25 @@ public function createDistanceThreshold($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteDistanceThreshold($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The unique ID number of the DistanceThreshold object you wish to delete. + * @return \stdClass + */ + public function deleteDistanceThreshold($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single DistanceThreshold - * + } + + /** + * Retrieve a single DistanceThreshold + * * Retrieves a single DistanceThreshold object defined by this URL. * * A company-distance-threshold model indicates the distance between a company @@ -5009,25 +5009,25 @@ public function deleteDistanceThreshold($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function getDistanceThreshold($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all DistanceThresholds for this company. - * + * @param int $id The unique ID number referring to this DistanceThreshold object + * @return \stdClass + */ + public function getDistanceThreshold($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all DistanceThresholds for this company. + * * Lists all DistanceThreshold objects that belong to this company. * * A company-distance-threshold model indicates the distance between a company @@ -5036,29 +5036,29 @@ public function getDistanceThreshold($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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/). * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listDistanceThresholds($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/distancethresholds"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all DistanceThreshold objects - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listDistanceThresholds($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/distancethresholds"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all DistanceThreshold objects + * * Lists all DistanceThreshold objects that belong to this account. * * A company-distance-threshold model indicates the distance between a company @@ -5070,28 +5070,28 @@ public function listDistanceThresholds($companyId, $filter=null, $include=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryDistanceThresholds($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/distancethresholds"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a DistanceThreshold object - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryDistanceThresholds($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/distancethresholds"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a DistanceThreshold object + * * Replace the existing DistanceThreshold object at this URL with an updated object. * * A company-distance-threshold model indicates the distance between a company @@ -5103,98 +5103,98 @@ public function queryDistanceThresholds($filter=null, $include=null, $top=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @param CompanyDistanceThresholdModel $model The new DistanceThreshold object to store. - * @return \stdClass - */ - public function updateDistanceThreshold($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CompanyDistanceThresholdModel $model The new DistanceThreshold object to store. + * @return \stdClass + */ + public function updateDistanceThreshold($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new eCommerce token. - * + } + + /** + * Create a new eCommerce token. + * * Creates a new eCommerce token. * * This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @return \stdClass - */ - public function createECommerceToken($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/ecommercetokens"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param CreateECommerceTokenInputModel $model + * @return \stdClass + */ + public function createECommerceToken($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/ecommercetokens"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Refresh an eCommerce token. - * + } + + /** + * Refresh an eCommerce token. + * * Refresh an eCommerce token. * * CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @return \stdClass - */ - public function refreshECommerceToken($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/ecommercetokens"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param RefreshECommerceTokenInputModel $model + * @return \stdClass + */ + public function refreshECommerceToken($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/ecommercetokens"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Approves linkage to a firm for a client account - * + } + + /** + * Approves linkage to a firm for a client account + * * This API enables the account admin of a client account to approve linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function approveFirmClientLinkage($id) { - $path = "/api/v2/firmclientlinkages/{$id}/approve"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id + * @return \stdClass + */ + public function approveFirmClientLinkage($id) { + $path = "/api/v2/firmclientlinkages/{$id}/approve"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Request a new FirmClient account and create an approved linkage to it - * + } + + /** + * Request a new FirmClient account and create an approved linkage to it + * * This API is for use by Firms only. * * Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service. @@ -5208,178 +5208,178 @@ public function approveFirmClientLinkage($id) { * * ### Security Policies * - * * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. - * Swagger Name: AvaTaxClient + * * 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 \stdClass - */ - public function createAndLinkNewFirmClientAccount($model) { - $path = "/api/v2/firmclientlinkages/createandlinkclient"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param NewFirmClientAccountRequestModel $model Information about the account you wish to create. + * @return \stdClass + */ + public function createAndLinkNewFirmClientAccount($model) { + $path = "/api/v2/firmclientlinkages/createandlinkclient"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Links a firm account with the client account - * + } + + /** + * Links a firm account with the client account + * * This API enables the firm admins/firm users to request the linkage of a firm account and a client account. * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient - * - * @param FirmClientLinkageInputModel $model FirmClientLinkageInputModel - * @return \stdClass - */ - public function createFirmClientLinkage($model) { - $path = "/api/v2/firmclientlinkages"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient + * + * @param FirmClientLinkageInputModel $model FirmClientLinkageInputModel + * @return \stdClass + */ + public function createFirmClientLinkage($model) { + $path = "/api/v2/firmclientlinkages"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a linkage - * + } + + /** + * Delete a linkage + * * This API marks a linkage between a firm and client as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function deleteFirmClientLinkage($id) { - $path = "/api/v2/firmclientlinkages/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id + * @return \stdClass + */ + public function deleteFirmClientLinkage($id) { + $path = "/api/v2/firmclientlinkages/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get linkage between a firm and client by id - * + } + + /** + * Get linkage between a firm and client by id + * * This API enables the firm admins/firm users to request the linkage of a firm account and a client account. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function getFirmClientLinkage($id) { - $path = "/api/v2/firmclientlinkages/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List client linkages for a firm or client - * + * @param int $id + * @return \stdClass + */ + public function getFirmClientLinkage($id) { + $path = "/api/v2/firmclientlinkages/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List client linkages for a firm or client + * * This API enables the firm or account users to request the associated linkages to the account. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass - */ - public function listFirmClientLinkage($filter=null) { - $path = "/api/v2/firmclientlinkages"; - $guzzleParams = [ - 'query' => ['$filter' => $filter], - 'body' => null - ]; + * @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 \stdClass + */ + public function listFirmClientLinkage($filter=null) { + $path = "/api/v2/firmclientlinkages"; + $guzzleParams = [ + 'query' => ['$filter' => $filter], + 'body' => null + ]; return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Rejects linkage to a firm for a client account - * + } + + /** + * Rejects linkage to a firm for a client account + * * This API enables the account admin of a client account to reject linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function rejectFirmClientLinkage($id) { - $path = "/api/v2/firmclientlinkages/{$id}/reject"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id + * @return \stdClass + */ + public function rejectFirmClientLinkage($id) { + $path = "/api/v2/firmclientlinkages/{$id}/reject"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Reset linkage status between a client and firm back to requested - * + } + + /** + * Reset linkage status between a client and firm back to requested + * * This API enables the firm admin of a client account to reset a previously created linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function resetFirmClientLinkage($id) { - $path = "/api/v2/firmclientlinkages/{$id}/reset"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id + * @return \stdClass + */ + public function resetFirmClientLinkage($id) { + $path = "/api/v2/firmclientlinkages/{$id}/reset"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Revokes previously approved linkage to a firm for a client account - * + } + + /** + * Revokes previously approved linkage to a firm for a client account + * * This API enables the account admin of a client account to revoke a previously approved linkage request by a firm. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * - * @param int $id - * @return \stdClass - */ - public function revokeFirmClientLinkage($id) { - $path = "/api/v2/firmclientlinkages/{$id}/revoke"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id + * @return \stdClass + */ + public function revokeFirmClientLinkage($id) { + $path = "/api/v2/firmclientlinkages/{$id}/revoke"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * FREE API - Request a free trial of AvaTax - * + } + + /** + * FREE API - Request a free trial of AvaTax + * * Call this API to obtain a free AvaTax account. * * This API is free to use. No authentication credentials are required to call this API. You must read and @@ -5393,24 +5393,24 @@ public function revokeFirmClientLinkage($id) { * * ### Security Policies * - * * This API may be called without providing authentication credentials. - * Swagger Name: AvaTaxClient + * * This API may be called without providing authentication credentials. + * Swagger Name: AvaTaxClient * - * @param FreeTrialRequestModel $model Required information to provision a free trial account. - * @return \stdClass - */ - public function requestFreeTrial($model) { - $path = "/api/v2/accounts/freetrials/request"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param FreeTrialRequestModel $model Required information to provision a free trial account. + * @return \stdClass + */ + public function requestFreeTrial($model) { + $path = "/api/v2/accounts/freetrials/request"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Request the javascript for a funding setup widget - * + } + + /** + * Request the javascript for a funding setup widget + * * This API is available by invitation only. * Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are * required to setup their funding configuration before Avalara can begin filing tax returns on their @@ -5427,26 +5427,26 @@ public function requestFreeTrial($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 + * * 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 * @param string $businessUnit The company's business unit (See POABusinessUnit::* for a list of allowable values) - * @param string $subscriptionType The company's subscription type (See POASubscriptionType::* for a list of allowable values) - * @return \stdClass - */ - public function activateFundingRequest($id, $businessUnit, $subscriptionType) { - $path = "/api/v2/fundingrequests/{$id}/widget"; - $guzzleParams = [ - 'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve status about a funding setup request - * + * @param string $subscriptionType The company's subscription type (See POASubscriptionType::* for a list of allowable values) + * @return \stdClass + */ + public function activateFundingRequest($id, $businessUnit, $subscriptionType) { + $path = "/api/v2/fundingrequests/{$id}/widget"; + $guzzleParams = [ + 'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve status about a funding setup request + * * This API is available by invitation only. * Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are * required to setup their funding configuration before Avalara can begin filing tax returns on their @@ -5461,26 +5461,26 @@ public function activateFundingRequest($id, $businessUnit, $subscriptionType) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 + * * 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 * @param string $businessUnit The company's business unit (See POABusinessUnit::* for a list of allowable values) - * @param string $subscriptionType The company's subscription type (See POASubscriptionType::* for a list of allowable values) - * @return \stdClass - */ - public function fundingRequestStatus($id, $businessUnit, $subscriptionType) { - $path = "/api/v2/fundingrequests/{$id}"; - $guzzleParams = [ - 'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete all classifications for an item - * + * @param string $subscriptionType The company's subscription type (See POASubscriptionType::* for a list of allowable values) + * @return \stdClass + */ + public function fundingRequestStatus($id, $businessUnit, $subscriptionType) { + $path = "/api/v2/fundingrequests/{$id}"; + $guzzleParams = [ + 'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Delete all classifications for an item + * * Delete all the classifications for a given item. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5489,25 +5489,25 @@ public function fundingRequestStatus($id, $businessUnit, $subscriptionType) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function batchDeleteItemClassifications($companyId, $itemId) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $itemId The ID of the item you wish to delete the classifications. + * @return \stdClass + */ + public function batchDeleteItemClassifications($companyId, $itemId) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete all parameters for an item - * + } + + /** + * Delete all parameters for an item + * * Delete all the parameters for a given item. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5518,25 +5518,25 @@ public function batchDeleteItemClassifications($companyId, $itemId) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function batchDeleteItemParameters($companyId, $itemId) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $itemId The ID of the item you wish to delete the parameters. + * @return \stdClass + */ + public function batchDeleteItemParameters($companyId, $itemId) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Bulk upload items from a product catalog - * + } + + /** + * Bulk upload items from a product catalog + * * Create/Update one or more item objects attached to this company. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5549,25 +5549,25 @@ public function batchDeleteItemParameters($companyId, $itemId) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function bulkUploadItems($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/items/upload"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemBulkUploadInputModel $model The items you wish to upload. + * @return \stdClass + */ + public function bulkUploadItems($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/items/upload"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Add classifications to an item. - * + } + + /** + * Add classifications to an item. + * * Add classifications to an item. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5578,26 +5578,26 @@ public function bulkUploadItems($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. - * @param ItemClassificationInputModel[] $model The item classifications you wish to create. - * @return \stdClass - */ - public function createItemClassifications($companyId, $itemId, $model) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemClassificationInputModel[] $model The item classifications you wish to create. + * @return \stdClass + */ + public function createItemClassifications($companyId, $itemId, $model) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Add parameters to an item. - * + } + + /** + * Add parameters to an item. + * * Add parameters to an item. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5612,26 +5612,26 @@ public function createItemClassifications($companyId, $itemId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @param ItemParameterModel[] $model The item parameters you wish to create. - * @return \stdClass - */ - public function createItemParameters($companyId, $itemId, $model) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemParameterModel[] $model The item parameters you wish to create. + * @return \stdClass + */ + public function createItemParameters($companyId, $itemId, $model) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new item - * + } + + /** + * Create a new item + * * Creates one or more new item objects attached to this company. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5644,51 +5644,51 @@ public function createItemParameters($companyId, $itemId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createItems($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/items"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemModel[] $model The item you wish to create. + * @return \stdClass + */ + public function createItems($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/items"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create tags for a item - * + } + + /** + * Create tags for a item + * * Creates one or more new `Tag` objects attached to this Item. * * Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @param ItemTagDetailInputModel[] $model Tags you wish to associate with the Item - * @return \stdClass - */ - public function createItemTags($companyId, $itemId, $model) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemTagDetailInputModel[] $model Tags you wish to associate with the Item + * @return \stdClass + */ + public function createItemTags($companyId, $itemId, $model) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new tax code classification request - * + } + + /** + * Create a new tax code classification request + * * Creates a new tax code classification request. * * Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and @@ -5697,25 +5697,25 @@ public function createItemTags($companyId, $itemId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that creates this request. - * @param ItemTaxCodeClassificationRequestInputModel $model The request you wish to create. - * @return \stdClass - */ - public function createTaxCodeClassificationRequest($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/classificationrequests/taxcode"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemTaxCodeClassificationRequestInputModel $model The request you wish to create. + * @return \stdClass + */ + public function createTaxCodeClassificationRequest($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/classificationrequests/taxcode"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single item - * + } + + /** + * Delete a single item + * * Deletes the item object at this URL. * * Items are a way of separating your tax calculation process from your tax configuration details. @@ -5734,25 +5734,25 @@ public function createTaxCodeClassificationRequest($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item. - * @param string $itemCode The code of the item you want to delete. - * @return \stdClass - */ - public function deleteCatalogueItem($companyId, $itemCode) { - $path = "/api/v2/companies/{$companyId}/itemcatalogue/{$itemCode}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param string $itemCode The code of the item you want to delete. + * @return \stdClass + */ + public function deleteCatalogueItem($companyId, $itemCode) { + $path = "/api/v2/companies/{$companyId}/itemcatalogue/{$itemCode}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single item - * + } + + /** + * Delete a single item + * * Deletes the item object at this URL. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5765,25 +5765,25 @@ public function deleteCatalogueItem($companyId, $itemCode) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteItem($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/items/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the item you wish to delete. + * @return \stdClass + */ + public function deleteItem($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/items/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single item classification. - * + } + + /** + * Delete a single item classification. + * * Delete a single item classification. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5792,26 +5792,26 @@ public function deleteItem($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. - * @param int $id The item classification id. - * @return \stdClass - */ - public function deleteItemClassification($companyId, $itemId, $id) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The item classification id. + * @return \stdClass + */ + public function deleteItemClassification($companyId, $itemId, $id) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single item parameter - * + } + + /** + * Delete a single item parameter + * * Delete a single item parameter. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5822,77 +5822,77 @@ public function deleteItemClassification($companyId, $itemId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $itemId The item id - * @param int $id The parameter id - * @return \stdClass - */ - public function deleteItemParameter($companyId, $itemId, $id) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The parameter id + * @return \stdClass + */ + public function deleteItemParameter($companyId, $itemId, $id) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete item tag by id - * + } + + /** + * Delete item tag by id + * * Deletes the `Tag` object of an Item at this URL. * * Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @param int $itemTagDetailId The ID of the item tag detail you wish to delete. - * @return \stdClass - */ - public function deleteItemTag($companyId, $itemId, $itemTagDetailId) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags/{$itemTagDetailId}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $itemTagDetailId The ID of the item tag detail you wish to delete. + * @return \stdClass + */ + public function deleteItemTag($companyId, $itemId, $itemTagDetailId) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags/{$itemTagDetailId}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete all item tags - * + } + + /** + * Delete all item tags + * * Deletes all `Tags` objects of an Item at this URL. * * Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteItemTags($companyId, $itemId) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $itemId The ID of the item as defined by the company that owns this tag. + * @return \stdClass + */ + public function deleteItemTags($companyId, $itemId) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get status of classification requests of a company - * + } + + /** + * Get status of classification requests of a company + * * Get status of tax code classification requests of a company. * * Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and @@ -5903,29 +5903,29 @@ public function deleteItemTags($companyId, $itemId) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 boolean $includeClassificationDetails A boolean field to get detailed classification status. * @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:* classificationDetails, totalItems * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function getClassificationStatus($companyId, $includeClassificationDetails, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/classificationrequests/taxcode"; - $guzzleParams = [ - 'query' => ['$includeClassificationDetails' => null === $includeClassificationDetails ? null : json_encode($includeClassificationDetails), '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single item - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function getClassificationStatus($companyId, $includeClassificationDetails, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/classificationrequests/taxcode"; + $guzzleParams = [ + 'query' => ['$includeClassificationDetails' => null === $includeClassificationDetails ? null : json_encode($includeClassificationDetails), '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single item + * * Get the `Item` object identified by this URL. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -5936,26 +5936,26 @@ public function getClassificationStatus($companyId, $includeClassificationDetail * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @param string $include A comma separated list of additional data to retrieve. - * @return \stdClass - */ - public function getItem($companyId, $id, $include=null) { - $path = "/api/v2/companies/{$companyId}/items/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single item classification. - * + * @param string $include A comma separated list of additional data to retrieve. + * @return \stdClass + */ + public function getItem($companyId, $id, $include=null) { + $path = "/api/v2/companies/{$companyId}/items/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single item classification. + * * Retrieve a single item classification. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -5964,26 +5964,26 @@ public function getItem($companyId, $id, $include=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. - * @param int $id The item classification id. - * @return \stdClass - */ - public function getItemClassification($companyId, $itemId, $id) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single item parameter - * + * @param int $id The item classification id. + * @return \stdClass + */ + public function getItemClassification($companyId, $itemId, $id) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single item parameter + * * Retrieve a single item parameter. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -5994,54 +5994,54 @@ public function getItemClassification($companyId, $itemId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $itemId The item id - * @param int $id The parameter id - * @return \stdClass - */ - public function getItemParameter($companyId, $itemId, $id) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve tags for an item - * + * @param int $id The parameter id + * @return \stdClass + */ + public function getItemParameter($companyId, $itemId, $id) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve tags for an item + * * Get the `Tag` objects of an Item identified by this URL. * * Item tags puts multiple labels for an item. So that item can be easily grouped by these tags. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @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:* tagName * @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. - * @return \stdClass - */ - public function getItemTags($companyId, $itemId, $filter=null, $top=null, $skip=null) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve premium classification for a company's item based on its ItemCode and SystemCode. - * + * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. + * @return \stdClass + */ + public function getItemTags($companyId, $itemId, $filter=null, $top=null, $skip=null) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/tags"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve premium classification for a company's item based on its ItemCode and SystemCode. + * * Retrieves the premium classification for an ItemCode and SystemCode. * * NOTE: If your item code contains any of these characters /, +, ?,",' ,% or #, please use the following encoding before making a request: @@ -6055,26 +6055,26 @@ public function getItemTags($companyId, $itemId, $filter=null, $top=null, $skip= * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 string $itemCode The ItemCode of the item for which you want to retrieve premium classification - * @param string $systemCode The SystemCode for which you want to retrieve premium classification - * @return \stdClass - */ - public function getPremiumClassification($companyId, $itemCode, $systemCode) { - $path = "/api/v2/companies/{$companyId}/items/{$itemCode}/premiumClassification/{$systemCode}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get tax code recommendations - * + * @param string $systemCode The SystemCode for which you want to retrieve premium classification + * @return \stdClass + */ + public function getPremiumClassification($companyId, $itemCode, $systemCode) { + $path = "/api/v2/companies/{$companyId}/items/{$itemCode}/premiumClassification/{$systemCode}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Get tax code recommendations + * * Get tax code recommendations. * * Avalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and @@ -6083,29 +6083,29 @@ public function getPremiumClassification($companyId, $itemCode, $systemCode) * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 $requestId The ID of the classification request * @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:* recommendations, url * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function getTaxCodeRecommendations($companyId, $requestId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/classificationrequests/taxcode/{$requestId}/recommendations"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve Restrictions for Item by CountryOfImport - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function getTaxCodeRecommendations($companyId, $requestId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/classificationrequests/taxcode/{$requestId}/recommendations"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve Restrictions for Item by CountryOfImport + * * Retrieve Restrictions for Item by CountryOfImport. This API will only return import restriction for the countryOfImport. * * NOTE: If your item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request: @@ -6119,29 +6119,29 @@ public function getTaxCodeRecommendations($companyId, $requestId, $filter=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 string $itemCode ItemCode for the item * @param string $countryOfImport Country for which you want the restrictions for the Item. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listImportRestrictions($companyId, $itemCode, $countryOfImport, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/items/{$itemCode}/restrictions/import/{$countryOfImport}"; - $guzzleParams = [ - 'query' => ['$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve classifications for an item. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listImportRestrictions($companyId, $itemCode, $countryOfImport, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/items/{$itemCode}/restrictions/import/{$countryOfImport}"; + $guzzleParams = [ + 'query' => ['$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve classifications for an item. + * * List classifications for an item. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -6153,29 +6153,29 @@ public function listImportRestrictions($companyId, $itemCode, $countryOfImport, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item 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:* productCode, systemCode + * @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:* productCode, systemCode, IsPremium * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listItemClassifications($companyId, $itemId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve parameters for an item - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listItemClassifications($companyId, $itemId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve parameters for an item + * * List parameters for an item. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -6189,29 +6189,29 @@ public function listItemClassifications($companyId, $itemId, $filter=null, $top= * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $itemId The item 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, isNeededForCalculation, isNeededForReturns, isNeededForClassification * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listItemParameters($companyId, $itemId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve items for this company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listItemParameters($companyId, $itemId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve items for this company + * * List all items defined for the current company. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -6235,8 +6235,8 @@ public function listItemParameters($companyId, $itemId, $filter=null, $top=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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, source, sourceEntityId, upc, classifications, parameters, tags, properties @@ -6244,21 +6244,21 @@ public function listItemParameters($companyId, $itemId, $filter=null, $top=null, * @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`. - * @param string $tagName Tag Name on the basis of which you want to filter Items - * @return \stdClass - */ - public function listItemsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null, $tagName=null) { - $path = "/api/v2/companies/{$companyId}/items"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, 'tagName' => $tagName], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all items - * + * @param string $tagName Tag Name on the basis of which you want to filter Items + * @return \stdClass + */ + public function listItemsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null, $tagName=null) { + $path = "/api/v2/companies/{$companyId}/items"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, 'tagName' => $tagName], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all items + * * Get multiple item objects across all companies. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -6273,28 +6273,28 @@ public function listItemsByCompany($companyId, $filter=null, $include=null, $top * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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, source, sourceEntityId, upc, classifications, parameters, tags, properties * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryItems($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/items"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all items associated with given tag - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryItems($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/items"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all items associated with given tag + * * Get multiple item objects associated with given tag. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -6309,8 +6309,8 @@ public function queryItems($filter=null, $include=null, $top=null, $skip=null, $ * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. @@ -6318,21 +6318,21 @@ public function queryItems($filter=null, $include=null, $top=null, $skip=null, $ * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryItemsByTag($companyId, $tag, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/items/bytags/{$tag}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create or update items from a product catalog. - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryItemsByTag($companyId, $tag, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/items/bytags/{$tag}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create or update items from a product catalog. + * * Creates/updates one or more item objects with additional properties and the AvaTax category attached to this company. * * Items are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to create @@ -6343,25 +6343,25 @@ public function queryItemsByTag($companyId, $tag, $filter=null, $include=null, $ * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The ID of the company that owns this item. - * @param ItemCatalogueInputModel[] $model The items you want to create or update. - * @return \stdClass - */ - public function syncItemCatalogue($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/itemcatalogue"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemCatalogueInputModel[] $model The items you want to create or update. + * @return \stdClass + */ + public function syncItemCatalogue($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/itemcatalogue"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Sync items from a product catalog - * + } + + /** + * Sync items from a product catalog + * * Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs * with AvaTax. * @@ -6377,25 +6377,25 @@ public function syncItemCatalogue($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function syncItems($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/items/sync"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param SyncItemsRequestModel $model The request object. + * @return \stdClass + */ + public function syncItems($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/items/sync"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single item - * + } + + /** + * Update a single item + * * Replace the existing `Item` object at this URL with an updated object. * * Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you @@ -6411,26 +6411,26 @@ public function syncItems($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param ItemModel $model The item object you wish to update. - * @return \stdClass - */ - public function updateItem($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/items/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemModel $model The item object you wish to update. + * @return \stdClass + */ + public function updateItem($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/items/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update an item classification. - * + } + + /** + * Update an item classification. + * * Update an item classification. * * A classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product. @@ -6441,27 +6441,27 @@ public function updateItem($companyId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id. * @param int $id The item classification id. - * @param ItemClassificationInputModel $model The item object you wish to update. - * @return \stdClass - */ - public function updateItemClassification($companyId, $itemId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemClassificationInputModel $model The item object you wish to update. + * @return \stdClass + */ + public function updateItemClassification($companyId, $itemId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update an item parameter - * + } + + /** + * Update an item parameter + * * Update an item parameter. * * Some items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called "parameters". @@ -6472,27 +6472,27 @@ public function updateItemClassification($companyId, $itemId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $itemId The item id * @param int $id The item parameter id - * @param ItemParameterModel $model The item object you wish to update. - * @return \stdClass - */ - public function updateItemParameter($companyId, $itemId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ItemParameterModel $model The item object you wish to update. + * @return \stdClass + */ + public function updateItemParameter($companyId, $itemId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create one or more overrides - * + } + + /** + * Create one or more overrides + * * Creates one or more jurisdiction override objects for this account. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -6502,48 +6502,48 @@ public function updateItemParameter($companyId, $itemId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function createJurisdictionOverrides($accountId, $model) { - $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param JurisdictionOverrideModel[] $model The jurisdiction override objects to create + * @return \stdClass + */ + public function createJurisdictionOverrides($accountId, $model) { + $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single override - * + } + + /** + * Delete a single override + * * Marks the item object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function deleteJurisdictionOverride($accountId, $id) { - $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the override you wish to delete + * @return \stdClass + */ + public function deleteJurisdictionOverride($accountId, $id) { + $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single override - * + } + + /** + * Retrieve a single override + * * Get the item object identified by this URL. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -6553,25 +6553,25 @@ public function deleteJurisdictionOverride($accountId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function getJurisdictionOverride($accountId, $id) { - $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve overrides for this account - * + * @param int $id The primary key of this override + * @return \stdClass + */ + public function getJurisdictionOverride($accountId, $id) { + $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve overrides for this account + * * List all jurisdiction override objects defined for this account. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -6584,29 +6584,29 @@ public function getJurisdictionOverride($accountId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listJurisdictionOverridesByAccount($accountId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all overrides - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listJurisdictionOverridesByAccount($accountId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all overrides + * * Get multiple jurisdiction override objects across all companies. * * A Jurisdiction Override is a configuration setting that allows you to select the taxing @@ -6619,52 +6619,52 @@ public function listJurisdictionOverridesByAccount($accountId, $filter=null, $in * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryJurisdictionOverrides($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/jurisdictionoverrides"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single jurisdictionoverride - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryJurisdictionOverrides($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/jurisdictionoverrides"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single jurisdictionoverride + * * Replace the existing jurisdictionoverride object at this URL with an updated object. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param JurisdictionOverrideModel $model The jurisdictionoverride object you wish to update. - * @return \stdClass - */ - public function updateJurisdictionOverride($accountId, $id, $model) { - $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param JurisdictionOverrideModel $model The jurisdictionoverride object you wish to update. + * @return \stdClass + */ + public function updateJurisdictionOverride($accountId, $id, $model) { + $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Add parameters to a location. - * + } + + /** + * Add parameters to a location. + * * Add parameters to a location. * * Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". @@ -6679,72 +6679,72 @@ public function updateJurisdictionOverride($accountId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @param LocationParameterModel[] $model The location parameters you wish to create. - * @return \stdClass - */ - public function createLocationParameters($companyId, $locationId, $model) { - $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LocationParameterModel[] $model The location parameters you wish to create. + * @return \stdClass + */ + public function createLocationParameters($companyId, $locationId, $model) { + $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new location - * + } + + /** + * Create a new location + * * Create one or more new location objects attached to this company. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createLocations($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/locations"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LocationModel[] $model The location you wish to create. + * @return \stdClass + */ + public function createLocations($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/locations"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single location - * + } + + /** + * Delete a single location + * * Mark the location object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteLocation($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/locations/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the location you wish to delete. + * @return \stdClass + */ + public function deleteLocation($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/locations/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single location parameter - * + } + + /** + * Delete a single location parameter + * * Delete a single location parameter. * * Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". @@ -6755,26 +6755,26 @@ public function deleteLocation($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $locationId The location id - * @param int $id The parameter id - * @return \stdClass - */ - public function deleteLocationParameter($companyId, $locationId, $id) { - $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The parameter id + * @return \stdClass + */ + public function deleteLocationParameter($companyId, $locationId, $id) { + $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single location - * + } + + /** + * Retrieve a single location + * * Get the location object identified by this URL. * An 'Location' represents a physical address where a company does business. * Many taxing authorities require that you define a list of all locations where your company does business. @@ -6788,26 +6788,26 @@ public function deleteLocationParameter($companyId, $locationId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @param string $include A comma separated list of additional data to retrieve. - * @return \stdClass - */ - public function getLocation($companyId, $id, $include=null) { - $path = "/api/v2/companies/{$companyId}/locations/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single company location parameter - * + * @param string $include A comma separated list of additional data to retrieve. + * @return \stdClass + */ + public function getLocation($companyId, $id, $include=null) { + $path = "/api/v2/companies/{$companyId}/locations/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single company location parameter + * * Retrieve a single location parameter. * * Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". @@ -6818,26 +6818,26 @@ public function getLocation($companyId, $id, $include=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $locationId The location id - * @param int $id The parameter id - * @return \stdClass - */ - public function getLocationParameter($companyId, $locationId, $id) { - $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve parameters for a location - * + * @param int $id The parameter id + * @return \stdClass + */ + public function getLocationParameter($companyId, $locationId, $id) { + $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve parameters for a location + * * List parameters for a location. * * Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". @@ -6851,29 +6851,29 @@ public function getLocationParameter($companyId, $locationId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 * @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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listLocationParameters($companyId, $locationId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve locations for this company - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listLocationParameters($companyId, $locationId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve locations for this company + * * List all location objects defined for this company. * An 'Location' represents a physical address where a company does business. * Many taxing authorities require that you define a list of all locations where your company does business. @@ -6889,29 +6889,29 @@ public function listLocationParameters($companyId, $locationId, $filter=null, $t * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listLocationsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/locations"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all locations - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listLocationsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/locations"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all locations + * * Get multiple location objects across all companies. * An 'Location' represents a physical address where a company does business. * Many taxing authorities require that you define a list of all locations where your company does business. @@ -6928,54 +6928,54 @@ public function listLocationsByCompany($companyId, $filter=null, $include=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryLocations($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/locations"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single location - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryLocations($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/locations"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single location + * * Replace the existing location object at this URL with an updated object. * All data from the existing object will be replaced with data in the object you PUT. * To set a field's value to null, you may either set its value to null or omit that field from the object you post. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param LocationModel $model The location you wish to update. - * @return \stdClass - */ - public function updateLocation($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/locations/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LocationModel $model The location you wish to update. + * @return \stdClass + */ + public function updateLocation($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/locations/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a location parameter - * + } + + /** + * Update a location parameter + * * Update a location parameter. * * Some locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called "parameters". @@ -6986,52 +6986,52 @@ public function updateLocation($companyId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $locationId The location id * @param int $id The location parameter id - * @param LocationParameterModel $model The location parameter object you wish to update. - * @return \stdClass - */ - public function updateLocationParameter($companyId, $locationId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param LocationParameterModel $model The location parameter object you wish to update. + * @return \stdClass + */ + public function updateLocationParameter($companyId, $locationId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/locations/{$locationId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Validate the location against local requirements - * + } + + /** + * Validate the location against local requirements + * * Returns validation information for this location. * This API call is intended to compare this location against the currently known taxing authority rules and regulations, * and provide information about what additional work is required to completely setup this location. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @return \stdClass - */ - public function validateLocation($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/locations/{$id}/validate"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Adjust a MultiDocument transaction - * + * @param int $id The primary key of this location + * @return \stdClass + */ + public function validateLocation($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/locations/{$id}/validate"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Adjust a MultiDocument transaction + * * Adjusts the current MultiDocument transaction uniquely identified by this URL. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -7054,27 +7054,27 @@ public function validateLocation($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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) * @param string $include Specifies objects to include in this fetch call - * @param AdjustMultiDocumentModel $model The adjust request you wish to execute - * @return \stdClass - */ - public function adjustMultiDocumentTransaction($code, $type, $include=null, $model=null) { - $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/adjust"; - $guzzleParams = [ - 'query' => ['include' => $include], - 'body' => json_encode($model) - ]; + * @param AdjustMultiDocumentModel $model The adjust request you wish to execute + * @return \stdClass + */ + public function adjustMultiDocumentTransaction($code, $type, $include=null, $model=null) { + $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/adjust"; + $guzzleParams = [ + 'query' => ['include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get audit information about a MultiDocument transaction - * + } + + /** + * Get audit information about a MultiDocument transaction + * * Retrieve audit information about a MultiDocument transaction stored in AvaTax. * * The audit API retrieves audit information related to a specific MultiDocument transaction. This audit @@ -7101,25 +7101,25 @@ public function adjustMultiDocumentTransaction($code, $type, $include=null, $mod * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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) - * @return \stdClass - */ - public function auditMultiDocumentTransaction($code, $type) { - $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/audit"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Commit a MultiDocument transaction - * + * @param string $type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) + * @return \stdClass + */ + public function auditMultiDocumentTransaction($code, $type) { + $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/audit"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Commit a MultiDocument transaction + * * Marks a list of transactions by changing its status to `Committed`. * * Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. @@ -7140,24 +7140,24 @@ public function auditMultiDocumentTransaction($code, $type) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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 \stdClass - */ - public function commitMultiDocumentTransaction($model) { - $path = "/api/v2/transactions/multidocument/commit"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function commitMultiDocumentTransaction($model) { + $path = "/api/v2/transactions/multidocument/commit"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new MultiDocument transaction - * + } + + /** + * Create a new MultiDocument transaction + * * Records a new MultiDocument transaction in AvaTax. * * A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can @@ -7202,25 +7202,25 @@ public function commitMultiDocumentTransaction($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function createMultiDocumentTransaction($include=null, $model=null) { - $path = "/api/v2/transactions/multidocument"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => json_encode($model) - ]; + * @param CreateMultiDocumentModel $model the multi document transaction model + * @return \stdClass + */ + public function createMultiDocumentTransaction($include=null, $model=null) { + $path = "/api/v2/transactions/multidocument"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a MultiDocument transaction - * + } + + /** + * Retrieve a MultiDocument transaction + * * Get the current MultiDocument transaction identified by this URL. * * If this transaction was adjusted, the return value of this API will be the current transaction with this code. @@ -7245,26 +7245,26 @@ public function createMultiDocumentTransaction($include=null, $model=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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) - * @param string $include Specifies objects to include in the response after transaction is created - * @return \stdClass - */ - public function getMultiDocumentTransactionByCodeAndType($code, $type, $include=null) { - $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a MultiDocument transaction by ID - * + * @param string $include Specifies objects to include in the response after transaction is created + * @return \stdClass + */ + public function getMultiDocumentTransactionByCodeAndType($code, $type, $include=null) { + $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a MultiDocument transaction by ID + * * Get the unique MultiDocument transaction identified by this URL. * * A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can @@ -7298,25 +7298,25 @@ public function getMultiDocumentTransactionByCodeAndType($code, $type, $include= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function getMultiDocumentTransactionById($id, $include=null) { - $path = "/api/v2/transactions/multidocument/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all MultiDocument transactions - * + * @param string $include Specifies objects to include in the response after transaction is created + * @return \stdClass + */ + public function getMultiDocumentTransactionById($id, $include=null) { + $path = "/api/v2/transactions/multidocument/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all MultiDocument transactions + * * List all MultiDocument transactions within this account. * * This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument @@ -7348,28 +7348,28 @@ public function getMultiDocumentTransactionById($id, $include=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listMultiDocumentTransactions($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/transactions/multidocument"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a refund for a MultiDocument transaction - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listMultiDocumentTransactions($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/transactions/multidocument"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create a refund for a MultiDocument transaction + * * Create a refund for a MultiDocument transaction. * * A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can @@ -7418,27 +7418,27 @@ public function listMultiDocumentTransactions($filter=null, $include=null, $top= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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) * @param string $include Specifies objects to include in the response after transaction is created - * @param RefundTransactionModel $model Information about the refund to create - * @return \stdClass - */ - public function refundMultiDocumentTransaction($code, $type, $include=null, $model=null) { - $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/refund"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => json_encode($model) - ]; + * @param RefundTransactionModel $model Information about the refund to create + * @return \stdClass + */ + public function refundMultiDocumentTransaction($code, $type, $include=null, $model=null) { + $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/refund"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Verify a MultiDocument transaction - * + } + + /** + * Verify a MultiDocument transaction + * * Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values. * * If the transaction does not match these expected values, this API will return an error code indicating which value did not match. @@ -7457,24 +7457,24 @@ public function refundMultiDocumentTransaction($code, $type, $include=null, $mod * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 \stdClass - */ - public function verifyMultiDocumentTransaction($model) { - $path = "/api/v2/transactions/multidocument/verify"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function verifyMultiDocumentTransaction($model) { + $path = "/api/v2/transactions/multidocument/verify"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Void a MultiDocument transaction - * + } + + /** + * Void a MultiDocument transaction + * * Voids the current transaction uniquely identified by this URL. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -7496,26 +7496,26 @@ public function verifyMultiDocumentTransaction($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro. - * Swagger Name: AvaTaxClient + * * 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) - * @param VoidTransactionModel $model The void request you wish to execute - * @return \stdClass - */ - public function voidMultiDocumentTransaction($code, $type, $model) { - $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/void"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param VoidTransactionModel $model The void request you wish to execute + * @return \stdClass + */ + public function voidMultiDocumentTransaction($code, $type, $model) { + $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/void"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new nexus - * + } + + /** + * Create a new nexus + * * Creates one or more new nexus declarations attached to this company. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7538,25 +7538,25 @@ public function voidMultiDocumentTransaction($code, $type, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createNexus($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/nexus"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param NexusModel[] $model The nexus you wish to create. + * @return \stdClass + */ + public function createNexus($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/nexus"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Add parameters to a nexus. - * + } + + /** + * Add parameters to a nexus. + * * Add parameters to the nexus. * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". * @@ -7570,26 +7570,26 @@ public function createNexus($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @param NexusParameterDetailModel[] $model The nexus parameters you wish to create. - * @return \stdClass - */ - public function createNexusParameters($companyId, $nexusId, $model) { - $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param NexusParameterDetailModel[] $model The nexus parameters you wish to create. + * @return \stdClass + */ + public function createNexusParameters($companyId, $nexusId, $model) { + $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Creates nexus for a list of addresses. - * + } + + /** + * Creates nexus for a list of addresses. + * * This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this * API declares nexus for this company, for the list of addresses provided, * for the date range provided. You may also use this API to extend effective date on an already-declared nexus. @@ -7608,25 +7608,25 @@ public function createNexusParameters($companyId, $nexusId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function declareNexusByAddress($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/nexus/byaddress"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param DeclareNexusByAddressModel[] $model The nexus you wish to create. + * @return \stdClass + */ + public function declareNexusByAddress($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/nexus/byaddress"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single nexus - * + } + + /** + * Delete a single nexus + * * Marks the existing nexus object at this URL as deleted. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7638,26 +7638,26 @@ public function declareNexusByAddress($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @param boolean $cascadeDelete If true, deletes all the child nexus if they exist along with parent nexus - * @return \stdClass - */ - public function deleteNexus($companyId, $id, $cascadeDelete) { - $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; - $guzzleParams = [ - 'query' => ['cascadeDelete' => null === $cascadeDelete ? null : json_encode($cascadeDelete)], - 'body' => null - ]; + * @param boolean $cascadeDelete If true, deletes all the child nexus if they exist along with parent nexus + * @return \stdClass + */ + public function deleteNexus($companyId, $id, $cascadeDelete) { + $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; + $guzzleParams = [ + 'query' => ['cascadeDelete' => null === $cascadeDelete ? null : json_encode($cascadeDelete)], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single nexus parameter - * + } + + /** + * Delete a single nexus parameter + * * Delete a single nexus parameter. * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". * @@ -7667,26 +7667,26 @@ public function deleteNexus($companyId, $id, $cascadeDelete) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id * @param int $nexusId The nexus id - * @param int $id The parameter id - * @return \stdClass - */ - public function deleteNexusParameter($companyId, $nexusId, $id) { - $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The parameter id + * @return \stdClass + */ + public function deleteNexusParameter($companyId, $nexusId, $id) { + $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete all parameters for an nexus - * + } + + /** + * Delete all parameters for an nexus + * * Delete all the parameters for a given nexus. * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". * @@ -7696,25 +7696,25 @@ public function deleteNexusParameter($companyId, $nexusId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteNexusParameters($companyId, $nexusId) { - $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $nexusId The ID of the nexus you wish to delete the parameters. + * @return \stdClass + */ + public function deleteNexusParameters($companyId, $nexusId) { + $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single nexus - * + } + + /** + * Retrieve a single nexus + * * Get the nexus object identified by this URL. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7726,26 +7726,26 @@ public function deleteNexusParameters($companyId, $nexusId) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @param string $include - * @return \stdClass - */ - public function getNexus($companyId, $id, $include=null) { - $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List company nexus related to a tax form - * + * @param string $include + * @return \stdClass + */ + public function getNexus($companyId, $id, $include=null) { + $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List company nexus related to a tax form + * * Retrieves a list of nexus related to a tax form. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7761,26 +7761,26 @@ public function getNexus($companyId, $id, $include=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @param string $include - * @return \stdClass - */ - public function getNexusByFormCode($companyId, $formCode, $include=null) { - $path = "/api/v2/companies/{$companyId}/nexus/byform/{$formCode}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single nexus parameter - * + * @param string $include + * @return \stdClass + */ + public function getNexusByFormCode($companyId, $formCode, $include=null) { + $path = "/api/v2/companies/{$companyId}/nexus/byform/{$formCode}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single nexus parameter + * * Retrieve a single nexus parameter. * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters". * @@ -7790,26 +7790,26 @@ public function getNexusByFormCode($companyId, $formCode, $include=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @param int $id The parameter id - * @return \stdClass - */ - public function getNexusParameter($companyId, $nexusId, $id) { - $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve nexus for this company - * + * @param int $id The parameter id + * @return \stdClass + */ + public function getNexusParameter($companyId, $nexusId, $id) { + $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve nexus for this company + * * List all nexus objects defined for this company. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7824,29 +7824,29 @@ public function getNexusParameter($companyId, $nexusId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/nexus"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve nexus for this company By TaxTypeGroup - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/nexus"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve nexus for this company By TaxTypeGroup + * * List all nexus objects defined for this company filtered by TaxTypeGroup. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7861,8 +7861,8 @@ public function listNexusByCompany($companyId, $filter=null, $include=null, $top * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 @@ -7870,21 +7870,21 @@ public function listNexusByCompany($companyId, $filter=null, $include=null, $top * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusByCompanyAndTaxTypeGroup($companyId, $taxTypeGroup, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/nexus/byTaxTypeGroup/{$taxTypeGroup}"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve parameters for a nexus - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusByCompanyAndTaxTypeGroup($companyId, $taxTypeGroup, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/nexus/byTaxTypeGroup/{$taxTypeGroup}"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve parameters for a nexus + * * List parameters for a nexus. * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". * @@ -7897,29 +7897,29 @@ public function listNexusByCompanyAndTaxTypeGroup($companyId, $taxTypeGroup, $fi * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 * @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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNexusParameters($companyId, $nexusId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all nexus - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNexusParameters($companyId, $nexusId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all nexus + * * Get multiple nexus objects across all companies. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7934,28 +7934,28 @@ public function listNexusParameters($companyId, $nexusId, $filter=null, $top=nul * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryNexus($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/nexus"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single nexus - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryNexus($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/nexus"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single nexus + * * Replace the existing nexus declaration object at this URL with an updated object. * * The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional @@ -7978,26 +7978,26 @@ public function queryNexus($filter=null, $include=null, $top=null, $skip=null, $ * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param NexusModel $model The nexus object you wish to update. - * @return \stdClass - */ - public function updateNexus($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param NexusModel $model The nexus object you wish to update. + * @return \stdClass + */ + public function updateNexus($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update an nexus parameter - * + } + + /** + * Update an nexus parameter + * * Update an nexus parameter. * * Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters". @@ -8008,117 +8008,117 @@ public function updateNexus($companyId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient * * @param int $companyId The company id. * @param int $nexusId The nexus id * @param int $id The nexus parameter id - * @param NexusParameterDetailModel $model The nexus object you wish to update. - * @return \stdClass - */ - public function updateNexusParameter($companyId, $nexusId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param NexusParameterDetailModel $model The nexus object you wish to update. + * @return \stdClass + */ + public function updateNexusParameter($companyId, $nexusId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/nexus/{$nexusId}/parameters/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Creates a new tax notice responsibility type. - * + } + + /** + * Creates a new tax notice responsibility type. + * * This API is available by invitation only and only available for users with Compliance admin access. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass - */ - public function createNoticeResponsibilityType($model) { - $path = "/api/v2/notices/responsibilities"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function createNoticeResponsibilityType($model) { + $path = "/api/v2/notices/responsibilities"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Creates a new tax notice root cause type. - * + } + + /** + * Creates a new tax notice root cause type. + * * This API is available by invitation only and only available for users with Compliance admin access. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass - */ - public function createNoticeRootCauseType($model) { - $path = "/api/v2/notices/rootcauses"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function createNoticeRootCauseType($model) { + $path = "/api/v2/notices/rootcauses"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a tax notice responsibility type. - * + } + + /** + * Delete a tax notice responsibility type. + * * This API is available by invitation only and only available for users with Compliance admin access. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass - */ - public function deleteNoticeResponsibilityType($responsibilityId) { - $path = "/api/v2/notices/responsibilities/{$responsibilityId}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass + */ + public function deleteNoticeResponsibilityType($responsibilityId) { + $path = "/api/v2/notices/responsibilities/{$responsibilityId}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a tax notice root cause type. - * + } + + /** + * Delete a tax notice root cause type. + * * This API is available by invitation only and only available for users with Compliance admin access. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass - */ - public function deleteNoticeRootCauseType($rootCauseId) { - $path = "/api/v2/notices/rootcauses/{$rootCauseId}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass + */ + public function deleteNoticeRootCauseType($rootCauseId) { + $path = "/api/v2/notices/rootcauses/{$rootCauseId}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Mark a single notification as dismissed. - * + } + + /** + * Mark a single notification as dismissed. + * * Marks the notification identified by this URL as dismissed. * * A notification is a message from Avalara that may have relevance to your business. You may want @@ -8136,24 +8136,24 @@ public function deleteNoticeRootCauseType($rootCauseId) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass - */ - public function dismissNotification($id) { - $path = "/api/v2/notifications/{$id}/dismiss"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The id of the notification you wish to mark as dismissed. + * @return \stdClass + */ + public function dismissNotification($id) { + $path = "/api/v2/notifications/{$id}/dismiss"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single notification. - * + } + + /** + * Retrieve a single notification. + * * Retrieve a single notification by its unique ID number. * * A notification is a message from Avalara that may have relevance to your business. You may want @@ -8165,24 +8165,24 @@ public function dismissNotification($id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass - */ - public function getNotification($id) { - $path = "/api/v2/notifications/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all notifications. - * + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass + */ + public function getNotification($id) { + $path = "/api/v2/notifications/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all notifications. + * * List all notifications. * * A notification is a message from Avalara that may have relevance to your business. You may want @@ -8197,27 +8197,27 @@ public function getNotification($id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listNotifications($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/notifications"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Request a new Avalara account - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listNotifications($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/notifications"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Request a new Avalara account + * * This API is for use by partner provisioning services customers only. * * Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features @@ -8237,24 +8237,24 @@ public function listNotifications($filter=null, $top=null, $skip=null, $orderBy= * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 \stdClass - */ - public function requestNewAccount($model) { - $path = "/api/v2/accounts/request"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function requestNewAccount($model) { + $path = "/api/v2/accounts/request"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Request a new entitilement to an existing customer - * + } + + /** + * Request a new entitilement to an existing customer + * * This API is for use by partner provisioning services customers only. This will allow the partners to allow * the add new entitlement to an existing customer * @@ -8262,25 +8262,25 @@ public function requestNewAccount($model) { * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 + * * 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 - * @return \stdClass - */ - public function requestNewEntitlement($id, $offer) { - $path = "/api/v2/accounts/{$id}/entitlements/{$offer}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param string $offer The offer to be added to an already existing customer + * @return \stdClass + */ + public function requestNewEntitlement($id, $offer) { + $path = "/api/v2/accounts/{$id}/entitlements/{$offer}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new account - * + } + + /** + * Create a new account + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -8289,24 +8289,24 @@ public function requestNewEntitlement($id, $offer) { * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient - * - * @param AccountModel $model The account you wish to create. - * @return \stdClass - */ - public function createAccount($model) { - $path = "/api/v2/accounts"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. + * Swagger Name: AvaTaxClient + * + * @param AccountModel $model The account you wish to create. + * @return \stdClass + */ + public function createAccount($model) { + $path = "/api/v2/accounts"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create new notifications. - * + } + + /** + * Create new notifications. + * * This API is available by invitation only. * * Create a single notification. @@ -8324,53 +8324,24 @@ public function createAccount($model) { * ### Security Policies * * * This API requires one of the following user roles: BatchServiceAdmin, 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 \stdClass - */ - public function createNotifications($model) { - $path = "/api/v2/notifications"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function createNotifications($model) { + $path = "/api/v2/notifications"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create Avalara-supported subscription (ServiceTypes) - * - * For Registrar Use Only - * This API is for use by Avalara Registrar administrative users only. - * - * Create one service/subscription object. - * - * Returns the newly created Avalara-supported subscription (service) type. - * This API is intended to be useful for adding new Avalara-supported subscription type (service type). - * You may always contact Avalara's sales department for information on available products or services. - * - * ### Security Policies - * - * * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient - * - * @param SubscriptionTypeModel $model The subscription type object you wish to create. - * @return \stdClass - */ - public function createServiceTypes($model) { - $path = "/api/v2/servicetypes"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; - return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new subscription - * + } + + /** + * Create a new subscription + * * This API is for use by Avalara Registrar administrative users only. * * Create one or more new subscription objects attached to this account. @@ -8379,25 +8350,25 @@ public function createServiceTypes($model) { * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createSubscriptions($accountId, $model) { - $path = "/api/v2/accounts/{$accountId}/subscriptions"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param SubscriptionModel[] $model The subscription you wish to create. + * @return \stdClass + */ + public function createSubscriptions($accountId, $model) { + $path = "/api/v2/accounts/{$accountId}/subscriptions"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single account - * + } + + /** + * Delete a single account + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -8406,24 +8377,24 @@ public function createSubscriptions($accountId, $model) { * * ### Security Policies * - * * This API requires the user role SystemAdmin. - * Swagger Name: AvaTaxClient + * * This API requires the user role SystemAdmin. + * Swagger Name: AvaTaxClient * - * @param int $id The ID of the account you wish to delete. - * @return \stdClass - */ - public function deleteAccount($id) { - $path = "/api/v2/accounts/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the account you wish to delete. + * @return \stdClass + */ + public function deleteAccount($id) { + $path = "/api/v2/accounts/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single notification. - * + } + + /** + * Delete a single notification. + * * This API is available by invitation only. * * Delete the existing notification identified by this URL. @@ -8438,50 +8409,24 @@ public function deleteAccount($id) { * ### Security Policies * * * This API requires one of the following user roles: BatchServiceAdmin, 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 \stdClass - */ - public function deleteNotification($id) { - $path = "/api/v2/notifications/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * * 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 \stdClass + */ + public function deleteNotification($id) { + $path = "/api/v2/notifications/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single Subscription (ServiceTypes) object - * - * For Registrar Use Only - * This API is for use by Avalara Registrar administrative users only. - * - * Marks the Subscription (ServiceTypes) object identified by this URL as deleted. - * This API is useful for deleting an existing Avalara-supported subscription type (service type). - * - * ### Security Policies - * - * * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient - * - * @param int $id The unique ID number of the Subscription object you wish to delete. - * @return \stdClass - */ - public function deleteServiceType($id) { - $path = "/api/v2/servicetypes/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single subscription - * + } + + /** + * Delete a single subscription + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -8489,25 +8434,25 @@ public function deleteServiceType($id) { * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteSubscription($accountId, $id) { - $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the subscription you wish to delete. + * @return \stdClass + */ + public function deleteSubscription($accountId, $id) { + $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve the full list of Avalara-supported subscription (ServiceTypes) - * + } + + /** + * Retrieve the full list of Avalara-supported subscription (ServiceTypes) + * * For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -8518,27 +8463,27 @@ public function deleteSubscription($accountId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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:* taxTypeGroupIdSK * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listServiceTypes($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/servicetypes/servicetypes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Reset a user's password programmatically - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listServiceTypes($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/servicetypes/servicetypes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Reset a user's password programmatically + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -8549,26 +8494,26 @@ public function listServiceTypes($filter=null, $top=null, $skip=null, $orderBy=n * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * 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 $isUndoMigrateRequest If user's password was migrated to AI, undo this. - * @param SetPasswordModel $model The new password for this user - * @return \stdClass - */ - public function resetPassword($userId, $isUndoMigrateRequest, $model) { - $path = "/api/v2/passwords/{$userId}/reset"; - $guzzleParams = [ - 'query' => ['isUndoMigrateRequest' => null === $isUndoMigrateRequest ? null : json_encode($isUndoMigrateRequest)], - 'body' => json_encode($model) - ]; + * @param SetPasswordModel $model The new password for this user + * @return \stdClass + */ + public function resetPassword($userId, $isUndoMigrateRequest, $model) { + $path = "/api/v2/passwords/{$userId}/reset"; + $guzzleParams = [ + 'query' => ['isUndoMigrateRequest' => null === $isUndoMigrateRequest ? null : json_encode($isUndoMigrateRequest)], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single account - * + } + + /** + * Update a single account + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -8576,25 +8521,25 @@ public function resetPassword($userId, $isUndoMigrateRequest, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: BatchServiceAdmin, 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. - * @return \stdClass - */ - public function updateAccount($id, $model) { - $path = "/api/v2/accounts/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param AccountModel $model The account object you wish to update. + * @return \stdClass + */ + public function updateAccount($id, $model) { + $path = "/api/v2/accounts/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single notification. - * + } + + /** + * Update a single notification. + * * This API is available by invitation only. * * Replaces the notification identified by this URL with a new notification. @@ -8609,53 +8554,25 @@ public function updateAccount($id, $model) { * ### Security Policies * * * This API requires one of the following user roles: BatchServiceAdmin, 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 + * * 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. - * @return \stdClass - */ - public function updateNotification($id, $model) { - $path = "/api/v2/notifications/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param NotificationModel $model The notification object you wish to update. + * @return \stdClass + */ + public function updateNotification($id, $model) { + $path = "/api/v2/notifications/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update existing Avalara-supported subscription (ServiceTypes) - * - * For Registrar Use Only - * This API is for use by Avalara Registrar administrative users only. - * - * Returns the updated Avalara-supported service types. - * This API is intended to be useful for updating an existing subscription(service) type detail. - * You may always contact Avalara's sales department for information on available products or services. - * - * ### Security Policies - * - * * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient - * - * @param int $id The unique ID number of the existing subscription type object to replace. - * @param SubscriptionTypeModel $model The subscription type object to update. - * @return \stdClass - */ - public function updateServiceType($id, $model) { - $path = "/api/v2/servicetypes/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; - return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single subscription - * + } + + /** + * Update a single subscription + * * # For Registrar Use Only * This API is for use by Avalara Registrar administrative users only. * @@ -8667,26 +8584,26 @@ public function updateServiceType($id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: BatchServiceAdmin, 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 - * @param SubscriptionModel $model The subscription you wish to update. - * @return \stdClass - */ - public function updateSubscription($accountId, $id, $model) { - $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param SubscriptionModel $model The subscription you wish to update. + * @return \stdClass + */ + public function updateSubscription($accountId, $id, $model) { + $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Download a report - * + } + + /** + * Download a report + * * This API downloads the file associated with a report. * * If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete, @@ -8704,24 +8621,24 @@ public function updateSubscription($accountId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient - * - * @param int $id The unique ID number of this report - * @return \stdClass - */ - public function downloadReport($id) { - $path = "/api/v2/reports/{$id}/attachment"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single report - * + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. + * Swagger Name: AvaTaxClient + * + * @param int $id The unique ID number of this report + * @return \stdClass + */ + public function downloadReport($id) { + $path = "/api/v2/reports/{$id}/attachment"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single report + * * Retrieve a single report by its unique ID number. * * Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download @@ -8732,24 +8649,24 @@ public function downloadReport($id) { * * Check the status of a report by calling `GetReport` and passing in the report's `id` value. * * 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 \stdClass - */ - public function getReport($id) { - $path = "/api/v2/reports/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Initiate an ExportDocumentLine report task - * + * 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 \stdClass + */ + public function getReport($id) { + $path = "/api/v2/reports/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Initiate an ExportDocumentLine report task + * * Begins running an `ExportDocumentLine` report task and returns the identity of the report. * * Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download @@ -8773,25 +8690,25 @@ public function getReport($id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function initiateExportDocumentLineReport($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/reports/exportdocumentline/initiate"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param ExportDocumentLineModel $model Options that may be configured to customize the report. + * @return \stdClass + */ + public function initiateExportDocumentLineReport($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/reports/exportdocumentline/initiate"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all report tasks for account - * + } + + /** + * List all report tasks for account + * * List all report tasks for your account. * * Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download @@ -8806,27 +8723,27 @@ public function initiateExportDocumentLineReport($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @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. - * @return \stdClass - */ - public function listReports($companyId, $pageKey, $skip=null, $top=null) { - $path = "/api/v2/reports"; - $guzzleParams = [ - 'query' => ['companyId' => $companyId, 'pageKey' => $pageKey, '$skip' => $skip, '$top' => $top], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new setting - * + * @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. + * @return \stdClass + */ + public function listReports($companyId, $pageKey, $skip=null, $top=null) { + $path = "/api/v2/reports"; + $guzzleParams = [ + 'query' => ['companyId' => $companyId, 'pageKey' => $pageKey, '$skip' => $skip, '$top' => $top], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create a new setting + * * Create one or more new setting objects attached to this company. * * The company settings system is a metadata system that you can use to store extra information @@ -8845,25 +8762,25 @@ public function listReports($companyId, $pageKey, $skip=null, $top=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createSettings($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/settings"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param SettingModel[] $model The setting you wish to create. + * @return \stdClass + */ + public function createSettings($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/settings"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single setting - * + } + + /** + * Delete a single setting + * * Mark the setting object at this URL as deleted. * * The company settings system is a metadata system that you can use to store extra information @@ -8877,25 +8794,25 @@ public function createSettings($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteSetting($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/settings/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the setting you wish to delete. + * @return \stdClass + */ + public function deleteSetting($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/settings/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single setting - * + } + + /** + * Retrieve a single setting + * * Get a single setting object by its unique ID. * * The company settings system is a metadata system that you can use to store extra information @@ -8909,25 +8826,25 @@ public function deleteSetting($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @return \stdClass - */ - public function getSetting($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/settings/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all settings for this company - * + * @param int $id The primary key of this setting + * @return \stdClass + */ + public function getSetting($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/settings/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all settings for this company + * * List all setting objects attached to this company. * * The company settings system is a metadata system that you can use to store extra information @@ -8944,29 +8861,29 @@ public function getSetting($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listSettingsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/settings"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all settings - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listSettingsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/settings"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all settings + * * Get multiple setting objects across all companies. * * The company settings system is a metadata system that you can use to store extra information @@ -8983,28 +8900,28 @@ public function listSettingsByCompany($companyId, $filter=null, $include=null, $ * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function querySettings($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/settings"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single setting - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function querySettings($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/settings"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single setting + * * Replace the existing setting object at this URL with an updated object. * * The company settings system is a metadata system that you can use to store extra information @@ -9022,51 +8939,51 @@ public function querySettings($filter=null, $include=null, $top=null, $skip=null * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param SettingModel $model The setting you wish to update. - * @return \stdClass - */ - public function updateSetting($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/settings/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param SettingModel $model The setting you wish to update. + * @return \stdClass + */ + public function updateSetting($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/settings/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single subscription - * + } + + /** + * Retrieve a single subscription + * * Get the subscription object identified by this URL. * A 'subscription' indicates a licensed subscription to a named Avalara service. * To request or remove subscriptions, please contact Avalara sales or your customer account manager. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function getSubscription($accountId, $id) { - $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve subscriptions for this account - * + * @param int $id The primary key of this subscription + * @return \stdClass + */ + public function getSubscription($accountId, $id) { + $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve subscriptions for this account + * * List all subscription objects attached to this account. * A 'subscription' indicates a licensed subscription to a named Avalara service. * To request or remove subscriptions, please contact Avalara sales or your customer account manager. @@ -9076,28 +8993,28 @@ public function getSubscription($accountId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listSubscriptionsByAccount($accountId, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/accounts/{$accountId}/subscriptions"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all subscriptions - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listSubscriptionsByAccount($accountId, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/accounts/{$accountId}/subscriptions"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all subscriptions + * * Get multiple subscription objects across all accounts. * A 'subscription' indicates a licensed subscription to a named Avalara service. * To request or remove subscriptions, please contact Avalara sales or your customer account manager. @@ -9107,27 +9024,27 @@ public function listSubscriptionsByAccount($accountId, $filter=null, $top=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function querySubscriptions($filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/subscriptions"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new tax code - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function querySubscriptions($filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/subscriptions"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create a new tax code + * * Create one or more new taxcode objects attached to this company. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -9136,48 +9053,48 @@ public function querySubscriptions($filter=null, $top=null, $skip=null, $orderBy * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createTaxCodes($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/taxcodes"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param TaxCodeModel[] $model The tax code you wish to create. + * @return \stdClass + */ + public function createTaxCodes($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/taxcodes"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single tax code - * + } + + /** + * Delete a single tax code + * * Marks the existing TaxCode object at this URL as deleted. * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteTaxCode($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the tax code you wish to delete. + * @return \stdClass + */ + public function deleteTaxCode($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single tax code - * + } + + /** + * Retrieve a single tax code + * * Get the taxcode object identified by this URL. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -9186,25 +9103,25 @@ public function deleteTaxCode($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 - * @return \stdClass - */ - public function getTaxCode($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve tax codes for this company - * + * @param int $id The primary key of this tax code + * @return \stdClass + */ + public function getTaxCode($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve tax codes for this company + * * List all taxcode objects attached to this company. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -9216,29 +9133,29 @@ public function getTaxCode($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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/). * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxCodesByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/taxcodes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all tax codes - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxCodesByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/taxcodes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all tax codes + * * Get multiple taxcode objects across all companies. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -9250,28 +9167,28 @@ public function listTaxCodesByCompany($companyId, $filter=null, $include=null, $ * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryTaxCodes($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/taxcodes"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single tax code - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryTaxCodes($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/taxcodes"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single tax code + * * Replace the existing taxcode object at this URL with an updated object. * A 'TaxCode' represents a uniquely identified type of product, good, or service. * Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions. @@ -9282,26 +9199,26 @@ public function queryTaxCodes($filter=null, $include=null, $top=null, $skip=null * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param TaxCodeModel $model The tax code you wish to update. - * @return \stdClass - */ - public function updateTaxCode($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param TaxCodeModel $model The tax code you wish to update. + * @return \stdClass + */ + public function updateTaxCode($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Build a multi-location tax content file - * + } + + /** + * Build a multi-location tax content file + * * Builds a tax content file containing information useful for a retail point-of-sale solution. * * Since tax rates may change based on decisions made by a variety of tax authorities, we recommend @@ -9329,24 +9246,24 @@ public function updateTaxCode($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 \stdClass - */ - public function buildTaxContentFile($model) { - $path = "/api/v2/pointofsaledata/build"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function buildTaxContentFile($model) { + $path = "/api/v2/pointofsaledata/build"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Build a tax content file for a single location - * + } + + /** + * Build a tax content file for a single location + * * Builds a tax content file containing information useful for a retail point-of-sale solution. * * Since tax rates may change based on decisions made by a variety of tax authorities, we recommend @@ -9374,29 +9291,29 @@ public function buildTaxContentFile($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 + * * 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. * @param string $date The date for which point-of-sale data would be calculated (today by default) * @param string $format The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values) * @param string $partnerId If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values) - * @param boolean $includeJurisCodes When true, the file will include jurisdiction codes in the result. - * @return \stdClass - */ - public function buildTaxContentFileForLocation($companyId, $id, $date, $format, $partnerId, $includeJurisCodes) { - $path = "/api/v2/companies/{$companyId}/locations/{$id}/pointofsaledata"; - $guzzleParams = [ - 'query' => ['date' => $date, 'format' => $format, 'partnerId' => $partnerId, 'includeJurisCodes' => null === $includeJurisCodes ? null : json_encode($includeJurisCodes)], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Download a file listing tax rates by postal code - * + * @param boolean $includeJurisCodes When true, the file will include jurisdiction codes in the result. + * @return \stdClass + */ + public function buildTaxContentFileForLocation($companyId, $id, $date, $format, $partnerId, $includeJurisCodes) { + $path = "/api/v2/companies/{$companyId}/locations/{$id}/pointofsaledata"; + $guzzleParams = [ + 'query' => ['date' => $date, 'format' => $format, 'partnerId' => $partnerId, 'includeJurisCodes' => null === $includeJurisCodes ? null : json_encode($includeJurisCodes)], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Download a file listing tax rates by postal code + * * Download a CSV file containing all five digit postal codes in the United States and their sales * and use tax rates for tangible personal property. * @@ -9440,25 +9357,25 @@ public function buildTaxContentFileForLocation($companyId, $id, $date, $format, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. - * @return \stdClass - */ - public function downloadTaxRatesByZipCode($date, $region) { - $path = "/api/v2/taxratesbyzipcode/download/{$date}"; - $guzzleParams = [ - 'query' => ['region' => $region], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Sales tax rates for a specified address - * + * @param string $region A two character region code which limits results to a specific region. + * @return \stdClass + */ + public function downloadTaxRatesByZipCode($date, $region) { + $path = "/api/v2/taxratesbyzipcode/download/{$date}"; + $guzzleParams = [ + 'query' => ['region' => $region], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Sales tax rates for a specified address + * * Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP * response code 429 - `Too Many Requests`. * @@ -9480,8 +9397,8 @@ public function downloadTaxRatesByZipCode($date, $region) { * * And more! * * 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 + * 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. @@ -9489,21 +9406,21 @@ public function downloadTaxRatesByZipCode($date, $region) { * @param string $city The city name of the location. * @param string $region Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`. * @param string $postalCode The postal code of the location. - * @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`. - * @return \stdClass - */ - public function taxRatesByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country) { - $path = "/api/v2/taxrates/byaddress"; - $guzzleParams = [ - 'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Sales tax rates for a specified country and postal code. This API is only available for US postal codes. - * + * @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`. + * @return \stdClass + */ + public function taxRatesByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country) { + $path = "/api/v2/taxrates/byaddress"; + $guzzleParams = [ + 'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Sales tax rates for a specified country and postal code. This API is only available for US postal codes. + * * This API is only available for a US postal codes. * * Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP @@ -9527,25 +9444,25 @@ public function taxRatesByAddress($line1, $line2, $line3, $city, $region, $posta * * And more! * * 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 + * 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. - * @return \stdClass - */ - public function taxRatesByPostalCode($country, $postalCode) { - $path = "/api/v2/taxrates/bypostalcode"; - $guzzleParams = [ - 'query' => ['country' => $country, 'postalCode' => $postalCode], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new tax rule - * + * @param string $postalCode The postal code of the location. + * @return \stdClass + */ + public function taxRatesByPostalCode($country, $postalCode) { + $path = "/api/v2/taxrates/bypostalcode"; + $guzzleParams = [ + 'query' => ['country' => $country, 'postalCode' => $postalCode], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Create a new tax rule + * * Create one or more custom tax rules attached to this company. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -9562,25 +9479,25 @@ public function taxRatesByPostalCode($country, $postalCode) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createTaxRules($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/taxrules"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param TaxRuleModel[] $model The tax rule you wish to create. + * @return \stdClass + */ + public function createTaxRules($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/taxrules"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single tax rule - * + } + + /** + * Delete a single tax rule + * * Mark the custom tax rule identified by this URL as deleted. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -9597,25 +9514,25 @@ public function createTaxRules($companyId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteTaxRule($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the tax rule you wish to delete. + * @return \stdClass + */ + public function deleteTaxRule($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single tax rule - * + } + + /** + * Retrieve a single tax rule + * * Get the taxrule object identified by this URL. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -9632,25 +9549,25 @@ public function deleteTaxRule($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function getTaxRule($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve tax rules for this company - * + * @param int $id The primary key of this tax rule + * @return \stdClass + */ + public function getTaxRule($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve tax rules for this company + * * List all taxrule objects attached to this company. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -9670,29 +9587,29 @@ public function getTaxRule($companyId, $id) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTaxRules($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/taxrules"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all tax rules - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTaxRules($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/taxrules"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all tax rules + * * Get multiple taxrule objects across all companies. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -9712,28 +9629,28 @@ public function listTaxRules($companyId, $filter=null, $include=null, $top=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryTaxRules($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/taxrules"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single tax rule - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryTaxRules($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/taxrules"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single tax rule + * * Replace the existing custom tax rule object at this URL with an updated object. * * A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules @@ -9750,26 +9667,26 @@ public function queryTaxRules($filter=null, $include=null, $top=null, $skip=null * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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 - * @param TaxRuleModel $model The tax rule you wish to update. - * @return \stdClass - */ - public function updateTaxRule($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param TaxRuleModel $model The tax rule you wish to update. + * @return \stdClass + */ + public function updateTaxRule($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Add lines to an existing unlocked transaction - * + } + + /** + * Add lines to an existing unlocked transaction + * * Add lines to an existing unlocked transaction. * * The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will @@ -9794,25 +9711,25 @@ public function updateTaxRule($companyId, $id, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function addLines($include=null, $model=null) { - $path = "/api/v2/companies/transactions/lines/add"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => json_encode($model) - ]; + * @param AddTransactionLineModel $model information about the transaction and lines to be added + * @return \stdClass + */ + public function addLines($include=null, $model=null) { + $path = "/api/v2/companies/transactions/lines/add"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Correct a previously created transaction - * + } + + /** + * Correct a previously created transaction + * * Replaces the current transaction uniquely identified by this URL with a new transaction. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -9846,28 +9763,28 @@ public function addLines($include=null, $model=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 * @param string $documentType (Optional): The document type of the transaction to adjust. (See DocumentType::* for a list of allowable values) * @param string $include Specifies objects to include in this fetch call - * @param AdjustTransactionModel $model The adjustment you wish to make - * @return \stdClass - */ - public function adjustTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/adjust"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => json_encode($model) - ]; + * @param AdjustTransactionModel $model The adjustment you wish to make + * @return \stdClass + */ + public function adjustTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/adjust"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get audit information about a transaction - * + } + + /** + * Get audit information about a transaction + * * Retrieve audit information about a transaction stored in AvaTax. * * The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit @@ -9895,25 +9812,25 @@ public function adjustTransaction($companyCode, $transactionCode, $documentType, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * 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 - * @return \stdClass - */ - public function auditTransaction($companyCode, $transactionCode) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/audit"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Get audit information about a transaction - * + * @param string $transactionCode The code identifying the transaction + * @return \stdClass + */ + public function auditTransaction($companyCode, $transactionCode) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/audit"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Get audit information about a transaction + * * Retrieve audit information about a transaction stored in AvaTax. * * The `AuditTransaction` API retrieves audit information related to a specific transaction. This audit @@ -9941,26 +9858,26 @@ public function auditTransaction($companyCode, $transactionCode) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * 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 - * @param string $documentType The document type of the original transaction (See DocumentType::* for a list of allowable values) - * @return \stdClass - */ - public function auditTransactionWithType($companyCode, $transactionCode, $documentType) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/types/{$documentType}/audit"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Lock a set of documents - * + * @param string $documentType The document type of the original transaction (See DocumentType::* for a list of allowable values) + * @return \stdClass + */ + public function auditTransactionWithType($companyCode, $transactionCode, $documentType) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/types/{$documentType}/audit"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Lock a set of documents + * * This API is available by invitation only. * * Lock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once. @@ -9972,24 +9889,24 @@ public function auditTransactionWithType($companyCode, $transactionCode, $docume * ### Security Policies * * * 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 \stdClass - */ - public function bulkLockTransaction($model) { - $path = "/api/v2/transactions/lock"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * 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 \stdClass + */ + public function bulkLockTransaction($model) { + $path = "/api/v2/transactions/lock"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Change a transaction's code - * + } + + /** + * Change a transaction's code + * * Renames a transaction uniquely identified by this URL by changing its `code` value. * * This API is available as long as the transaction is in `saved` or `posted` status. When a transaction @@ -10023,28 +9940,28 @@ public function bulkLockTransaction($model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 * @param string $documentType (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string $include Specifies objects to include in this fetch call - * @param ChangeTransactionCodeModel $model The code change request you wish to execute - * @return \stdClass - */ - public function changeTransactionCode($companyCode, $transactionCode, $documentType, $include=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/changecode"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => json_encode($model) - ]; + * @param ChangeTransactionCodeModel $model The code change request you wish to execute + * @return \stdClass + */ + public function changeTransactionCode($companyCode, $transactionCode, $documentType, $include=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/changecode"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Commit a transaction for reporting - * + } + + /** + * Commit a transaction for reporting + * * Marks a transaction by changing its status to `Committed`. * * Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns. @@ -10076,28 +9993,28 @@ public function changeTransactionCode($companyCode, $transactionCode, $documentT * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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 * @param string $documentType (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string $include Specifies objects to include in this fetch call - * @param CommitTransactionModel $model The commit request you wish to execute - * @return \stdClass - */ - public function commitTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/commit"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => json_encode($model) - ]; + * @param CommitTransactionModel $model The commit request you wish to execute + * @return \stdClass + */ + public function commitTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/commit"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create or adjust a transaction - * + } + + /** + * Create or adjust a transaction + * * Records a new transaction or adjust an existing transaction in AvaTax. * * The `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API @@ -10137,25 +10054,25 @@ public function commitTransaction($companyCode, $transactionCode, $documentType, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function createOrAdjustTransaction($include=null, $model=null) { - $path = "/api/v2/transactions/createoradjust"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => json_encode($model) - ]; + * @param CreateOrAdjustTransactionModel $model The transaction you wish to create or adjust + * @return \stdClass + */ + public function createOrAdjustTransaction($include=null, $model=null) { + $path = "/api/v2/transactions/createoradjust"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new transaction - * + } + + /** + * Create a new transaction + * * Records a new transaction in AvaTax. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -10202,25 +10119,25 @@ public function createOrAdjustTransaction($include=null, $model=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function createTransaction($include=null, $model=null) { - $path = "/api/v2/transactions/create"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => json_encode($model) - ]; + * @param CreateTransactionModel $model The transaction you wish to create + * @return \stdClass + */ + public function createTransaction($include=null, $model=null) { + $path = "/api/v2/transactions/create"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Remove lines from an existing unlocked transaction - * + } + + /** + * Remove lines from an existing unlocked transaction + * * Remove lines to an existing unlocked transaction. * * The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will @@ -10242,46 +10159,46 @@ public function createTransaction($include=null, $model=null) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function deleteLines($include=null, $model=null) { - $path = "/api/v2/companies/transactions/lines/delete"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => json_encode($model) - ]; + * @param RemoveTransactionLineModel $model information about the transaction and lines to be removed + * @return \stdClass + */ + public function deleteLines($include=null, $model=null) { + $path = "/api/v2/companies/transactions/lines/delete"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Fetches the Variance data generated for all the transactions done by Company. - * + } + + /** + * Fetches the Variance data generated for all the transactions done by Company. + * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 - * @return \stdClass - */ - public function getAllVarianceReportByCompanyCode($companyCode) { - $path = "/api/v2/companies/{$companyCode}/AllVariance"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single transaction by code - * + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + * Swagger Name: AvaTaxClient + * + * @param string $companyCode + * @return \stdClass + */ + public function getAllVarianceReportByCompanyCode($companyCode) { + $path = "/api/v2/companies/{$companyCode}/AllVariance"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single transaction by code + * * Get the current transaction identified by this company code, transaction code, and document type. * * A transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`. @@ -10312,27 +10229,27 @@ public function getAllVarianceReportByCompanyCode($companyCode) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * 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 * @param string $documentType (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values) - * @param string $include Specifies objects to include in this fetch call - * @return \stdClass - */ - public function getTransactionByCode($companyCode, $transactionCode, $documentType, $include=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single transaction by code - * + * @param string $include Specifies objects to include in this fetch call + * @return \stdClass + */ + public function getTransactionByCode($companyCode, $transactionCode, $documentType, $include=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single transaction by code + * * DEPRECATED: Please use the `GetTransactionByCode` API instead. * * NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request: @@ -10346,27 +10263,27 @@ public function getTransactionByCode($companyCode, $transactionCode, $documentTy * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * 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 * @param string $documentType The transaction type to retrieve (See DocumentType::* for a list of allowable values) - * @param string $include Specifies objects to include in this fetch call - * @return \stdClass - */ - public function getTransactionByCodeAndType($companyCode, $transactionCode, $documentType, $include=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/types/{$documentType}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single transaction by ID - * + * @param string $include Specifies objects to include in this fetch call + * @return \stdClass + */ + public function getTransactionByCodeAndType($companyCode, $transactionCode, $documentType, $include=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/types/{$documentType}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve a single transaction by ID + * * Get the unique transaction identified by this URL. * * This endpoint retrieves the exact transaction identified by this ID number, as long as it is the most version of the transaction. @@ -10387,47 +10304,47 @@ public function getTransactionByCodeAndType($companyCode, $transactionCode, $doc * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * 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 - * @return \stdClass - */ - public function getTransactionById($id, $include=null) { - $path = "/api/v2/transactions/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Fetches the Variance data generated for particular Company by transaction ID - * + * @param string $include Specifies objects to include in this fetch call + * @return \stdClass + */ + public function getTransactionById($id, $include=null) { + $path = "/api/v2/transactions/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Fetches the Variance data generated for particular Company by transaction ID + * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + * Swagger Name: AvaTaxClient * * @param string $companyCode - * @param string $transactionId - * @return \stdClass - */ - public function getVarianceReportByCompanyCodeByTransactionId($companyCode, $transactionId) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionId}/variance"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all transactions - * + * @param string $transactionId + * @return \stdClass + */ + public function getVarianceReportByCompanyCodeByTransactionId($companyCode, $transactionId) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionId}/variance"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all transactions + * * List all transactions attached to this company. * * This endpoint is limited to returning 1,000 transactions at a time maximum. @@ -10461,8 +10378,8 @@ public function getVarianceReportByCompanyCodeByTransactionId($companyCode, $tra * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * 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. @@ -10470,21 +10387,21 @@ public function getVarianceReportByCompanyCodeByTransactionId($companyCode, $tra * @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:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listTransactionsByCompany($companyCode, $dataSourceId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyCode}/transactions"; - $guzzleParams = [ - 'query' => ['dataSourceId' => $dataSourceId, '$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Lock a single transaction - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listTransactionsByCompany($companyCode, $dataSourceId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyCode}/transactions"; + $guzzleParams = [ + 'query' => ['dataSourceId' => $dataSourceId, '$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Lock a single transaction + * * Lock a transaction uniquely identified by this URL. * * This API is mainly used for connector developers to simulate what happens when the Returns product locks a document. @@ -10518,28 +10435,28 @@ public function listTransactionsByCompany($companyCode, $dataSourceId, $include= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged. - * Swagger Name: AvaTaxClient + * * 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 * @param string $documentType (Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string $include Specifies objects to include in this fetch call - * @param LockTransactionModel $model The lock request you wish to execute - * @return \stdClass - */ - public function lockTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/lock"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => json_encode($model) - ]; + * @param LockTransactionModel $model The lock request you wish to execute + * @return \stdClass + */ + public function lockTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/lock"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a refund for a transaction - * + } + + /** + * Create a refund for a transaction + * * Create a refund for a transaction. * * The `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund @@ -10583,29 +10500,29 @@ public function lockTransaction($companyCode, $transactionCode, $documentType, $ * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 * @param string $include Specifies objects to include in the response after transaction is created * @param string $documentType (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param boolean $useTaxDateOverride (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states). - * @param RefundTransactionModel $model Information about the refund to create - * @return \stdClass - */ - public function refundTransaction($companyCode, $transactionCode, $include=null, $documentType=null, $useTaxDateOverride=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/refund"; - $guzzleParams = [ - 'query' => ['$include' => $include, 'documentType' => $documentType, 'useTaxDateOverride' => null === $useTaxDateOverride ? null : json_encode($useTaxDateOverride)], - 'body' => json_encode($model) - ]; + * @param RefundTransactionModel $model Information about the refund to create + * @return \stdClass + */ + public function refundTransaction($companyCode, $transactionCode, $include=null, $documentType=null, $useTaxDateOverride=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/refund"; + $guzzleParams = [ + 'query' => ['$include' => $include, 'documentType' => $documentType, 'useTaxDateOverride' => null === $useTaxDateOverride ? null : json_encode($useTaxDateOverride)], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Perform multiple actions on a transaction - * + } + + /** + * Perform multiple actions on a transaction + * * Performs one or more actions against the current transaction uniquely identified by this URL. * * The `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`. @@ -10637,28 +10554,28 @@ public function refundTransaction($companyCode, $transactionCode, $include=null, * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, 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 * @param string $documentType (Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string $include Specifies objects to include in this fetch call - * @param SettleTransactionModel $model The data from an external system to reconcile against AvaTax - * @return \stdClass - */ - public function settleTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/settle"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => json_encode($model) - ]; + * @param SettleTransactionModel $model The data from an external system to reconcile against AvaTax + * @return \stdClass + */ + public function settleTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/settle"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Uncommit a transaction for reporting - * + } + + /** + * Uncommit a transaction for reporting + * * Adjusts a transaction by changing it to an uncommitted status. * * Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are @@ -10685,27 +10602,27 @@ public function settleTransaction($companyCode, $transactionCode, $documentType, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 * @param string $documentType (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) - * @param string $include Specifies objects to include in this fetch call - * @return \stdClass - */ - public function uncommitTransaction($companyCode, $transactionCode, $documentType, $include=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/uncommit"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => null - ]; + * @param string $include Specifies objects to include in this fetch call + * @return \stdClass + */ + public function uncommitTransaction($companyCode, $transactionCode, $documentType, $include=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/uncommit"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Unvoids a transaction - * + } + + /** + * Unvoids a transaction + * * Unvoids a voided transaction * * You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values: @@ -10729,49 +10646,49 @@ public function uncommitTransaction($companyCode, $transactionCode, $documentTyp * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 * @param string $documentType (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) - * @param string $include Specifies objects to include in this fetch call - * @return \stdClass - */ - public function unvoidTransaction($companyCode, $transactionCode, $documentType, $include=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/unvoid"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => null - ]; + * @param string $include Specifies objects to include in this fetch call + * @return \stdClass + */ + public function unvoidTransaction($companyCode, $transactionCode, $documentType, $include=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/unvoid"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => null + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Generates the Variance report which will capture the difference between "Tax Calculated by Avalara" Vs "Actual Tax" paid at custom clearance at line / header level. - * + } + + /** + * Generates the Variance report which will capture the difference between "Tax Calculated by Avalara" Vs "Actual Tax" paid at custom clearance at line / header level. + * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 + * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. + * Swagger Name: AvaTaxClient * * @param string $companyCode - * @param VarianceRequestModel[] $model - * @return \stdClass - */ - public function varianceReport($companyCode, $model) { - $path = "/api/v2/companies/{$companyCode}/variance"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param VarianceRequestModel[] $model + * @return \stdClass + */ + public function varianceReport($companyCode, $model) { + $path = "/api/v2/companies/{$companyCode}/variance"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Verify a transaction - * + } + + /** + * Verify a transaction + * * Verifies that the transaction uniquely identified by this URL matches certain expected values. * * If the transaction does not match these expected values, this API will return an error code indicating which value did not match. @@ -10802,28 +10719,28 @@ public function varianceReport($companyCode, $model) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 * @param string $documentType (Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string $include Specifies objects to include in this fetch call - * @param VerifyTransactionModel $model The data from an external system to reconcile against AvaTax - * @return \stdClass - */ - public function verifyTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/verify"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => json_encode($model) - ]; + * @param VerifyTransactionModel $model The data from an external system to reconcile against AvaTax + * @return \stdClass + */ + public function verifyTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/verify"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Void a transaction - * + } + + /** + * Void a transaction + * * Voids the current transaction uniquely identified by this URL. * * A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like @@ -10856,102 +10773,102 @@ public function verifyTransaction($companyCode, $transactionCode, $documentType, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 * @param string $documentType (Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values) * @param string $include Specifies objects to include in this fetch call - * @param VoidTransactionModel $model The void request you wish to execute. To void a transaction the code must be set to 'DocVoided' - * @return \stdClass - */ - public function voidTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/void"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, '$include' => $include], - 'body' => json_encode($model) - ]; + * @param VoidTransactionModel $model The void request you wish to execute. To void a transaction the code must be set to 'DocVoided' + * @return \stdClass + */ + public function voidTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/void"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, '$include' => $include], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create a new UPC - * + } + + /** + * Create a new UPC + * * Create one or more new UPC objects attached to this company. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaUpc. - * Swagger Name: AvaTaxClient + * * 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. - * @return \stdClass - */ - public function createUPCs($companyId, $model) { - $path = "/api/v2/companies/{$companyId}/upcs"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param UPCModel[] $model The UPC you wish to create. + * @return \stdClass + */ + public function createUPCs($companyId, $model) { + $path = "/api/v2/companies/{$companyId}/upcs"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single UPC - * + } + + /** + * Delete a single UPC + * * Marks the UPC object identified by this URL as deleted. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaUpc. - * Swagger Name: AvaTaxClient + * * 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. - * @return \stdClass - */ - public function deleteUPC($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The ID of the UPC you wish to delete. + * @return \stdClass + */ + public function deleteUPC($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single UPC - * + } + + /** + * Retrieve a single UPC + * * Get the UPC object identified by this URL. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaUpc. - * Swagger Name: AvaTaxClient + * * 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 - * @return \stdClass - */ - public function getUPC($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve UPCs for this company - * + * @param int $id The primary key of this UPC + * @return \stdClass + */ + public function getUPC($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve UPCs for this company + * * List all UPC objects attached to this company. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * @@ -10961,29 +10878,29 @@ public function getUPC($companyId, $id) { * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaUpc. - * Swagger Name: AvaTaxClient + * * 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/). * @param string $include A comma separated list of additional data to retrieve. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listUPCsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/companies/{$companyId}/upcs"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all UPCs - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listUPCsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/companies/{$companyId}/upcs"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all UPCs + * * Get multiple UPC objects across all companies. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * @@ -10993,28 +10910,28 @@ public function listUPCsByCompany($companyId, $filter=null, $include=null, $top= * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services:*Required* (all): AvaUpc. - * Swagger Name: AvaTaxClient + * * 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. * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryUPCs($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/upcs"; - $guzzleParams = [ - 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single UPC - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryUPCs($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/upcs"; + $guzzleParams = [ + 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single UPC + * * Replace the existing UPC object at this URL with an updated object. * A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC. * All data from the existing object will be replaced with data in the object you PUT. @@ -11023,98 +10940,98 @@ public function queryUPCs($filter=null, $include=null, $top=null, $skip=null, $o * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaUpc. - * Swagger Name: AvaTaxClient + * * 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 - * @param UPCModel $model The UPC you wish to update. - * @return \stdClass - */ - public function updateUPC($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param UPCModel $model The UPC you wish to update. + * @return \stdClass + */ + public function updateUPC($companyId, $id, $model) { + $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a User Defined Field by User Defined Field id for a company. - * + } + + /** + * 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, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 \stdClass - */ - public function deleteUserDefinedField($companyId, $id) { - $path = "/api/v2/companies/{$companyId}/userdefinedfields/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $id The id of the User Defined Field you wish to delete. + * @return \stdClass + */ + public function deleteUserDefinedField($companyId, $id) { + $path = "/api/v2/companies/{$companyId}/userdefinedfields/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * - * + } + + /** + * + * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 + * * 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 \stdClass - */ - public function listUserDefinedFieldsByCompanyId($companyId, $udfType, $allowDefaults) { - $path = "/api/v2/companies/{$companyId}/userdefinedfields"; - $guzzleParams = [ - 'query' => ['udfType' => $udfType, 'allowDefaults' => null === $allowDefaults ? null : json_encode($allowDefaults)], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a User Defined Field identified by id for a company - * + * @param boolean $allowDefaults If true this will add defaulted UDFs to the list that are not named yet + * @return \stdClass + */ + public function listUserDefinedFieldsByCompanyId($companyId, $udfType, $allowDefaults) { + $path = "/api/v2/companies/{$companyId}/userdefinedfields"; + $guzzleParams = [ + 'query' => ['udfType' => $udfType, 'allowDefaults' => null === $allowDefaults ? null : json_encode($allowDefaults)], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * 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, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns. - * Swagger Name: AvaTaxClient + * * 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 \stdClass - */ - public function updateUserDefinedField($companyId, $id, $model) { - $path = "/api/v2/companies/{$companyId}/userdefinedfields"; - $guzzleParams = [ - 'query' => ['id' => $id], - 'body' => json_encode($model) - ]; + * @param CompanyUserDefinedFieldModel $model + * @return \stdClass + */ + 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, AVATAX_SDK_VERSION ); - } - - /** - * Change Password - * + } + + /** + * Change Password + * * Allows a user to change their password via an API call. * * This API allows an authenticated user to change their password via an API call. This feature is only available @@ -11125,24 +11042,24 @@ public function updateUserDefinedField($companyId, $id, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 \stdClass - */ - public function changePassword($model) { - $path = "/api/v2/passwords"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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 \stdClass + */ + public function changePassword($model) { + $path = "/api/v2/passwords"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Create new users - * + } + + /** + * Create new users + * * Create one or more new user objects attached to this account. * * A user represents one person with access privileges to make API calls and work with a specific account. @@ -11155,25 +11072,25 @@ public function changePassword($model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function createUsers($accountId, $model) { - $path = "/api/v2/accounts/{$accountId}/users"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param UserModel[] $model The user or array of users you wish to create. + * @return \stdClass + */ + public function createUsers($accountId, $model) { + $path = "/api/v2/accounts/{$accountId}/users"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Delete a single user - * + } + + /** + * Delete a single user + * * Mark the user object identified by this URL as deleted. * * This API is available for use by account and company administrators only. @@ -11183,25 +11100,25 @@ public function createUsers($accountId, $model) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, 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. - * @return \stdClass - */ - public function deleteUser($id, $accountId) { - $path = "/api/v2/accounts/{$accountId}/users/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; + * @param int $accountId The accountID of the user you wish to delete. + * @return \stdClass + */ + public function deleteUser($id, $accountId) { + $path = "/api/v2/accounts/{$accountId}/users/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve a single user - * + } + + /** + * Retrieve a single user + * * Get the user object identified by this URL. * A user represents one person with access privileges to make API calls and work with a specific account. * @@ -11211,26 +11128,26 @@ public function deleteUser($id, $accountId) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. - * @param string $include Optional fetch commands. - * @return \stdClass - */ - public function getUser($id, $accountId, $include=null) { - $path = "/api/v2/accounts/{$accountId}/users/{$id}"; - $guzzleParams = [ - 'query' => ['$include' => $include], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all entitlements for a single user - * + * @param string $include Optional fetch commands. + * @return \stdClass + */ + public function getUser($id, $accountId, $include=null) { + $path = "/api/v2/accounts/{$accountId}/users/{$id}"; + $guzzleParams = [ + 'query' => ['$include' => $include], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all entitlements for a single user + * * Return a list of all entitlements to which this user has rights to access. * Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is * allowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use. @@ -11249,25 +11166,25 @@ public function getUser($id, $accountId, $include=null) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. - * @return \stdClass - */ - public function getUserEntitlements($id, $accountId) { - $path = "/api/v2/accounts/{$accountId}/users/{$id}/entitlements"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve users for this account - * + * @param int $accountId The accountID of the user you wish to get. + * @return \stdClass + */ + public function getUserEntitlements($id, $accountId) { + $path = "/api/v2/accounts/{$accountId}/users/{$id}/entitlements"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve users for this account + * * List all user objects attached to this account. * A user represents one person with access privileges to make API calls and work with a specific account. * @@ -11283,29 +11200,29 @@ public function getUserEntitlements($id, $accountId) { * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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. * @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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function listUsersByAccount($accountId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/accounts/{$accountId}/users"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Retrieve all users - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function listUsersByAccount($accountId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/accounts/{$accountId}/users"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Retrieve all users + * * Get multiple user objects across all accounts. * * A user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated @@ -11323,28 +11240,28 @@ public function listUsersByAccount($accountId, $include=null, $filter=null, $top * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, 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 * @param int $top If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. - * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. - * @return \stdClass - */ - public function queryUsers($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { - $path = "/api/v2/users"; - $guzzleParams = [ - 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Update a single user - * + * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. + * @return \stdClass + */ + public function queryUsers($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) { + $path = "/api/v2/users"; + $guzzleParams = [ + 'query' => ['$include' => $include, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Update a single user + * * Replace the existing user object at this URL with an updated object. * A user represents one person with access privileges to make API calls and work with a specific account. * All data from the existing object will be replaced with data in the object you PUT. @@ -11352,26 +11269,26 @@ public function queryUsers($include=null, $filter=null, $top=null, $skip=null, $ * * ### Security Policies * - * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * Swagger Name: AvaTaxClient + * * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, 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. - * @param UserModel $model The user object you wish to update. - * @return \stdClass - */ - public function updateUser($id, $accountId, $model) { - $path = "/api/v2/accounts/{$accountId}/users/{$id}"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * @param UserModel $model The user object you wish to update. + * @return \stdClass + */ + public function updateUser($id, $accountId, $model) { + $path = "/api/v2/accounts/{$accountId}/users/{$id}"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Checks if the current user is subscribed to a specific service - * + } + + /** + * Checks if the current user is subscribed to a specific service + * * Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account. * * This API will return an error if it is called with invalid authentication credentials. @@ -11379,24 +11296,24 @@ public function updateUser($id, $accountId, $model) { * This API is intended to help you determine whether you have the necessary subscription to use certain API calls * 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 \stdClass - */ - public function getMySubscription($serviceTypeId) { - $path = "/api/v2/utilities/subscriptions/{$serviceTypeId}"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * List all services to which the current user is subscribed - * + * specific features of AvaTax. + * Swagger Name: AvaTaxClient + * + * @param string $serviceTypeId The service to check + * @return \stdClass + */ + public function getMySubscription($serviceTypeId) { + $path = "/api/v2/utilities/subscriptions/{$serviceTypeId}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * List all services to which the current user is subscribed + * * Returns the list of all subscriptions enabled for the currently logged in user. * * This API will return an error if it is called with invalid authentication credentials. @@ -11404,23 +11321,23 @@ public function getMySubscription($serviceTypeId) { * This API is intended to help you determine whether you have the necessary subscription to use certain API calls * 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 \stdClass - */ - public function listMySubscriptions() { - $path = "/api/v2/utilities/subscriptions"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Tests connectivity and version of the service - * + * specific features of AvaTax. + * Swagger Name: AvaTaxClient + * + * @return \stdClass + */ + public function listMySubscriptions() { + $path = "/api/v2/utilities/subscriptions"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Tests connectivity and version of the service + * * Check connectivity to AvaTax and return information about the AvaTax API server. * * This API is intended to help you verify that your connection is working. This API will always succeed and will @@ -11440,23 +11357,23 @@ public function listMySubscriptions() { * * ### Security Policies * - * * This API may be called without providing authentication credentials. - * Swagger Name: AvaTaxClient - * - * @return \stdClass - */ - public function ping() { - $path = "/api/v2/utilities/ping"; - $guzzleParams = [ - 'query' => [], - 'body' => null - ]; - return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Fetches a previously stored age verification response. - * + * * This API may be called without providing authentication credentials. + * Swagger Name: AvaTaxClient + * + * @return \stdClass + */ + public function ping() { + $path = "/api/v2/utilities/ping"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION ); + } + + /** + * Fetches a previously stored age verification response. + * * 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*: @@ -11466,24 +11383,24 @@ public function ping() { * * Optionally, the request 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*] - * Swagger Name: AvaTaxBeverageClient - * - * @param AgeVerifyRequest $model Information about the individual whose age is being verified. - * @return \stdClass - */ - public function findAgeVerification($model) { - $path = "/api/v2/ageverification/store/identity/find"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * The valid values for this attribute are [*US, USA*] + * Swagger Name: AvaTaxBeverageClient + * + * @param AgeVerifyRequest $model Information about the individual whose age is being verified. + * @return \stdClass + */ + public function findAgeVerification($model) { + $path = "/api/v2/ageverification/store/identity/find"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Stores an age verification response for the account. - * + } + + /** + * Stores an age verification response for the account. + * * The request field 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*: @@ -11497,24 +11414,24 @@ public function findAgeVerification($model) { * * * The response field must meet the following criteria in order to be evaluated: - * * *isOfAge*, *failureCodes* are required fields - * Swagger Name: AvaTaxBeverageClient - * - * @param StoreAgeVerifyRequest $model Information about the individual whose age has been verified and the corresponding age verification response. - * @return \stdClass - */ - public function storeAgeVerification($model) { - $path = "/api/v2/ageverification/store/identity"; - $guzzleParams = [ - 'query' => [], - 'body' => json_encode($model) - ]; + * * *isOfAge*, *failureCodes* are required fields + * Swagger Name: AvaTaxBeverageClient + * + * @param StoreAgeVerifyRequest $model Information about the individual whose age has been verified and the corresponding age verification response. + * @return \stdClass + */ + public function storeAgeVerification($model) { + $path = "/api/v2/ageverification/store/identity"; + $guzzleParams = [ + 'query' => [], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Conditionally performs an age verification check. If a record matching the request is found in the internal store, the associated response is returned. Otherwise, an age verification check is performed and the response is stored if the individual is determined to be of age. - * + } + + /** + * Conditionally performs an age verification check. If a record matching the request is found in the internal store, the associated response is returned. Otherwise, an age verification check is performed and the response is stored if the individual is determined to be of 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*: @@ -11524,25 +11441,25 @@ public function storeAgeVerification($model) { * * Optionally, the request 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*] - * Swagger Name: AvaTaxBeverageClient + * * The valid values for this attribute are [*US, USA*] + * 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 \stdClass - */ - public function storeIfVerified($simulatedFailureCode, $model) { - $path = "/api/v2/ageverification/store/identity/storeIfVerified"; - $guzzleParams = [ - 'query' => ['simulatedFailureCode' => $simulatedFailureCode], - 'body' => json_encode($model) - ]; + * @param AgeVerifyRequest $model Information about the individual whose age is being verified. + * @return \stdClass + */ + public function storeIfVerified($simulatedFailureCode, $model) { + $path = "/api/v2/ageverification/store/identity/storeIfVerified"; + $guzzleParams = [ + 'query' => ['simulatedFailureCode' => $simulatedFailureCode], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Determines whether an individual meets or exceeds the minimum legal drinking age. - * + } + + /** + * 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*: @@ -11555,94 +11472,94 @@ public function storeIfVerified($simulatedFailureCode, $model) { * * The valid values for this attribute are [*US, USA*] * * **Security Policies** - * This API depends on the active subscription *AgeVerification* - * Swagger Name: AvaTaxBeverageClient + * 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 \stdClass - */ - public function verifyAge($simulatedFailureCode, $model) { - $path = "/api/v2/ageverification/verify"; - $guzzleParams = [ - 'query' => ['simulatedFailureCode' => $simulatedFailureCode], - 'body' => json_encode($model) - ]; + * @param AgeVerifyRequest $model Information about the individual whose age is being verified. + * @return \stdClass + */ + public function verifyAge($simulatedFailureCode, $model) { + $path = "/api/v2/ageverification/verify"; + $guzzleParams = [ + 'query' => ['simulatedFailureCode' => $simulatedFailureCode], + 'body' => json_encode($model) + ]; return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION ); - } - - /** - * Removes the transaction from consideration when evaluating regulations that span multiple transactions. - * - * - * Swagger Name: AvaTaxBeverageClient + } + + /** + * 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" * @param string $api_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2 - * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. - * @return \stdClass - */ - public function deregisterShipment($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, 'api-version' => $api_version], - 'body' => null - ]; + * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. + * @return \stdClass + */ + public function deregisterShipment($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, 'api-version' => $api_version], + 'body' => null + ]; $headerParams=['x-avalara-version' => $x_avalara_version]; return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION, $headerParams ); - } - - /** - * Registers the transaction so that it may be included when evaluating regulations that span multiple transactions. - * - * - * Swagger Name: AvaTaxBeverageClient + } + + /** + * 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" * @param string $api_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2 - * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. - * @return \stdClass - */ - public function registerShipment($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, 'api-version' => $api_version], - 'body' => null - ]; + * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. + * @return \stdClass + */ + public function registerShipment($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, 'api-version' => $api_version], + 'body' => null + ]; $headerParams=['x-avalara-version' => $x_avalara_version]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION, $headerParams ); - } - - /** - * 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 + } + + /** + * 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" * @param string $api_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2 - * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. - * @return \stdClass - */ - public function registerShipmentIfCompliant($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registerIfCompliant"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, 'api-version' => $api_version], - 'body' => null - ]; + * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. + * @return \stdClass + */ + public function registerShipmentIfCompliant($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registerIfCompliant"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, 'api-version' => $api_version], + 'body' => null + ]; $headerParams=['x-avalara-version' => $x_avalara_version]; return $this->restCall($path, 'PUT', $guzzleParams, AVATAX_SDK_VERSION, $headerParams ); - } - - /** - * Evaluates a transaction against a set of direct-to-consumer shipping regulations. - * + } + + /** + * 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*' @@ -11658,25 +11575,25 @@ public function registerShipmentIfCompliant($companyCode, $transactionCode, $doc * * The *SalesLocation* parameter may be used to describe whether the sale was made *OnSite* or *OffSite*. *OffSite* is the default value. * * **Security Policies** - * This API depends on all of the following active subscriptions: *AvaAlcohol, AutoAddress, AvaTaxPro* - * Swagger Name: AvaTaxBeverageClient + * 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" * @param string $api_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2 - * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. - * @return \stdClass - */ - public function verifyShipment($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { - $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/verify"; - $guzzleParams = [ - 'query' => ['documentType' => $documentType, 'api-version' => $api_version], - 'body' => null - ]; + * @param string $x_avalara_version (Optional): API version that should satisfy the request. If omitted, defaults to 2.2. Header takes precendence if both header and query parameters are present. + * @return \stdClass + */ + public function verifyShipment($companyCode, $transactionCode, $documentType, $api_version= "" , $x_avalara_version= "" ) { + $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/verify"; + $guzzleParams = [ + 'query' => ['documentType' => $documentType, 'api-version' => $api_version], + 'body' => null + ]; $headerParams=['x-avalara-version' => $x_avalara_version]; return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION, $headerParams ); - } - -} -?> + } + +} +?> \ No newline at end of file diff --git a/src/Models.php b/src/Models.php index ae2aae2..1821e84 100644 --- a/src/Models.php +++ b/src/Models.php @@ -1702,6 +1702,10 @@ class ClassificationModel * @var string The system code in which the product belongs. */ public $systemCode; + /** + * @var boolean If there is an premium classification justification present for this classification + */ + public $isPremium; } /** * usage of system defined parameters. @@ -6859,6 +6863,10 @@ class ItemClassificationOutputModel * @var string A unique code representing this item. */ public $systemCode; + /** + * @var boolean If there is an premium classification justification present for this classification + */ + public $isPremium; } /** * Represents an item in your company's product catalog.