diff --git a/src/Constants.php b/src/Constants.php
index 7a9b8a2..af7573b 100644
--- a/src/Constants.php
+++ b/src/Constants.php
@@ -2,7 +2,7 @@
namespace Avalara;
use GuzzleHttp\Client;
-define('AVATAX_SDK_VERSION', '24.6.3');
+define('AVATAX_SDK_VERSION', '24.8.2');
/*****************************************************************************
* *
@@ -1121,6 +1121,16 @@ class ErrorCodeId
*/
const C_INVALIDTAXCODEIDINRECOMMENDATIONSTATUSUPDATE = 2815;
+ /**
+ * ECM communication certificates error
+ */
+ const C_COMMUNICATIONCERTIFICATESERROR = 2816;
+
+ /**
+ * Invalid currency and aggrement type combination
+ */
+ const C_INVALIDCURRENCYAGGREMENTTYPE = 2817;
+
/**
* Occurs when a Header value is incorrect or invalid in some way
*/
@@ -3414,19 +3424,19 @@ class DeemedSellerType
*/
class APStatus
{ const C_NOACCRUALMATCH = 0;
- const C_SHORTPAYITEMSACCRUEMATCH = 1;
- const C_MARKFORREVIEWMATCH = 2;
- const C_REJECTMATCH = 3;
+ const C_ACCRUEDSHORTPAYITEMSMATCH = 1;
+ const C_NEEDREVIEWMATCH = 2;
+ const C_NOACCRUALREJECTMATCH = 3;
const C_NOACCRUALUNDERCHARGE = 4;
const C_ACCRUEDUNDERCHARGE = 5;
- const C_SHORTPAYITEMSACCRUEUNDERCHARGE = 6;
+ const C_ACCRUEDSHORTPAYITEMSUNDERCHARGE = 6;
const C_NEEDREVIEWUNDERCHARGE = 7;
- const C_REJECTUNDERCHARGE = 8;
+ const C_NOACCRUALREJECTUNDERCHARGE = 8;
const C_NOACCRUALOVERCHARGE = 9;
- const C_SHORTPAYAVALARACALCULATED = 10;
- const C_SHORTPAYITEMSACCRUEOVERCHARGE = 11;
- const C_MARKFORREVIEWOVERCHARGE = 12;
- const C_REJECTOVERCHARGE = 13;
+ const C_NOACCRUALSHORTPAYAVALARACALCULATED = 10;
+ const C_ACCRUEDSHORTPAYITEMSOVERCHARGE = 11;
+ const C_NEEDREVIEWOVERCHARGE = 12;
+ const C_NOACCRUALREJECTOVERCHARGE = 13;
const C_NOACCRUALAMOUNTTHRESHOLDNOTMET = 14;
const C_NOACCRUALEXEMPTEDCOSTCENTER = 15;
const C_NOACCRUALEXEMPTEDITEM = 16;
@@ -3437,6 +3447,18 @@ class APStatus
const C_NOACCRUALEXEMPTEDGLACCOUNT = 21;
const C_PENDINGACCRUALVENDOR = 22;
const C_PENDINGACCRUALUNDERCHARGE = 23;
+ const C_PENDINGSHORTPAYITEMSUNDERCHARGE = 24;
+ const C_PENDINGSHORTPAYITEMSMATCH = 25;
+ const C_PENDINGSHORTPAYITEMSOVERCHARGE = 26;
+ const C_SHORTPAYITEMSACCRUEMATCH = -1;
+ const C_MARKFORREVIEWMATCH = -1;
+ const C_REJECTMATCH = -1;
+ const C_SHORTPAYITEMSACCRUEUNDERCHARGE = -1;
+ const C_REJECTUNDERCHARGE = -1;
+ const C_SHORTPAYAVALARACALCULATED = -1;
+ const C_SHORTPAYITEMSACCRUEOVERCHARGE = -1;
+ const C_MARKFORREVIEWOVERCHARGE = -1;
+ const C_REJECTOVERCHARGE = -1;
}
diff --git a/src/Methods.php b/src/Methods.php
index bf17ba2..0da28b2 100644
--- a/src/Methods.php
+++ b/src/Methods.php
@@ -120,7 +120,7 @@ public function activateAccount($id, $model) {
* @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) {
+ public function auditAccount($id, $start=null, $end=null, $top=null, $skip=null) {
$path = "/api/v2/accounts/{$id}/audit";
$guzzleParams = [
'query' => ['start' => $start, 'end' => $end, '$top' => $top, '$skip' => $skip],
@@ -418,7 +418,7 @@ public function setAccountConfiguration($id, $model) {
* @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) {
+ public function resolveAddress($line1=null, $line2=null, $line3=null, $city=null, $region=null, $postalCode=null, $country=null, $textCase=null) {
$path = "/api/v2/addresses/resolve";
$guzzleParams = [
'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country, 'textCase' => $textCase],
@@ -467,7 +467,7 @@ public function resolveAddressPost($model) {
* @param APConfigSettingRequestModel $model The AP Config Setting you wish to create.
* @return \stdClass
*/
- public function createAPConfigSetting($companyid, $model) {
+ public function createAPConfigSetting($companyid, $model=null) {
$path = "/api/v2/companies/{$companyid}/apconfigsetting";
$guzzleParams = [
'query' => [],
@@ -531,7 +531,7 @@ public function queryAPConfigSetting($filter=null, $include=null, $top=null, $sk
* @param APConfigSettingRequestModel $model The AP config setting object you wish to update.
* @return \stdClass
*/
- public function updateAPConfigSetting($companyid, $model) {
+ public function updateAPConfigSetting($companyid, $model=null) {
$path = "/api/v2/companies/{$companyid}/apconfigsetting";
$guzzleParams = [
'query' => [],
@@ -1116,7 +1116,7 @@ public function listCertExpressInvitations($companyId, $include=null, $filter=nu
* @param CertificateModel[] $model Certificates to be created
* @return \stdClass
*/
- public function createCertificates($companyId, $preValidatedExemptionReason, $model) {
+ public function createCertificates($companyId, $preValidatedExemptionReason=null, $model=null) {
$path = "/api/v2/companies/{$companyId}/certificates";
$guzzleParams = [
'query' => ['$preValidatedExemptionReason' => null === $preValidatedExemptionReason ? null : json_encode($preValidatedExemptionReason)],
@@ -1191,7 +1191,7 @@ public function deleteCertificate($companyId, $id) {
* @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) {
+ public function downloadCertificateImage($companyId, $id, $page=null, $type=null) {
$path = "/api/v2/companies/{$companyId}/certificates/{$id}/attachment";
$guzzleParams = [
'query' => ['$page' => $page, '$type' => $type],
@@ -1215,6 +1215,11 @@ public function downloadCertificateImage($companyId, $id, $page, $type) {
* * customers - Retrieves the list of customers linked to the certificate.
* * po_numbers - Retrieves all PO numbers tied to the certificate.
* * attributes - Retrieves all attributes applied to the certificate.
+ * * histories - Retrieves the certificate update history
+ * * jobs - Retrieves the jobs for this certificate
+ * * logs - Retrieves the certificate log
+ * * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
+ * * custom_fields - Retrieves custom fields set for this certificate
*
* Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
* Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -1229,7 +1234,7 @@ public function downloadCertificateImage($companyId, $id, $page, $type) {
*
* @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.
+ * @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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
* @return \stdClass
*/
public function getCertificate($companyId, $id, $include=null) {
@@ -1437,7 +1442,12 @@ public function listCustomersForCertificate($companyId, $id, $include=null) {
* * customers - Retrieves the list of customers linked to the certificate.
* * po_numbers - Retrieves all PO numbers tied to the certificate.
* * attributes - Retrieves all attributes applied to the certificate.
- *
+ * * histories - Retrieves the certificate update history
+ * * jobs - Retrieves the jobs for this certificate
+ * * logs - Retrieves the certificate log
+ * * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
+ * * custom_fields - Retrieves custom fields set for this certificate
+ *
* Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
* Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
* certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
@@ -1450,7 +1460,7 @@ public function listCustomersForCertificate($companyId, $id, $include=null) {
* 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 $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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
* @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, ecmStatus, 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.
@@ -1648,6 +1658,59 @@ public function uploadCertificateImage($companyId, $id, $file) {
return $this->restCall($path, 'POST', $guzzleParams, AVATAX_SDK_VERSION );
}
+ /**
+ * Retrieve a single communication certificate.
+ *
+ * ### Security Policies
+ *
+ * * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+ * Swagger Name: AvaTaxClient
+ *
+ * @param int $companyId The ID number of the company to search
+ * @param int $certificateId The ID number of the certifificate to search
+ * @return \stdClass
+ */
+ public function getCommunicationCertificate($companyId, $certificateId) {
+ $path = "/companies/{$companyId}/communication-certificates/{$certificateId}";
+ $guzzleParams = [
+ 'query' => [],
+ 'body' => null
+ ];
+ return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION );
+ }
+
+ /**
+ * Retrieve all communication certificates.
+ *
+ * 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.
+ *
+ * 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.
+ * For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
+ *
+ * ### Security Policies
+ *
+ * * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+ * 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, ExpirationDate, TaxNumber, Exemptions
+ * @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 int $companyId The ID number of the company to search
+ * @return \stdClass
+ */
+ public function listCommunicationCertificates($filter=null, $top=null, $skip=null, $orderBy=null, $companyId=null) {
+ $path = "/companies/{$companyId}/communication-certificates";
+ $guzzleParams = [
+ 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy],
+ 'body' => null
+ ];
+ return $this->restCall($path, 'GET', $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.
*
@@ -1845,7 +1908,7 @@ public function createCompanyParameters($companyId, $model) {
* @param FundingInitiateModel $model The funding initialization request
* @return \stdClass
*/
- public function createFundingRequest($id, $businessUnit, $subscriptionType, $model) {
+ public function createFundingRequest($id, $businessUnit=null, $subscriptionType=null, $model=null) {
$path = "/api/v2/companies/{$id}/funding/setup";
$guzzleParams = [
'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType],
@@ -1948,7 +2011,7 @@ public function fundingConfigurationByCompany($companyId) {
* @param string $currency The currency of the funding. USD and CAD are the only valid currencies
* @return \stdClass
*/
- public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) {
+ public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency=null) {
$path = "/api/v2/companies/{$companyId}/funding/configurations";
$guzzleParams = [
'query' => ['currency' => $currency],
@@ -2301,7 +2364,7 @@ public function setCompanyConfiguration($id, $model) {
* @param CompanyModel $model The company object you wish to update.
* @return \stdClass
*/
- public function updateCompany($id, $model) {
+ public function updateCompany($id, $model=null) {
$path = "/api/v2/companies/{$id}";
$guzzleParams = [
'query' => [],
@@ -2331,7 +2394,7 @@ public function updateCompany($id, $model) {
* @param CompanyParameterDetailModel $model The company parameter object you wish to update.
* @return \stdClass
*/
- public function updateCompanyParameterDetail($companyId, $id, $model) {
+ public function updateCompanyParameterDetail($companyId, $id, $model=null) {
$path = "/api/v2/companies/{$companyId}/parameters/{$id}";
$guzzleParams = [
'query' => [],
@@ -2358,7 +2421,7 @@ public function updateCompanyParameterDetail($companyId, $id, $model) {
* @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
* @return \stdClass
*/
- public function queryJurisNames($country, $region, $effectiveDate, $endDate, $filter=null, $top=null, $skip=null, $orderBy=null) {
+ public function queryJurisNames($country, $region, $effectiveDate=null, $endDate=null, $filter=null, $top=null, $skip=null, $orderBy=null) {
$path = "/api/v2/compliance/jurisnames/{$country}/{$region}";
$guzzleParams = [
'query' => ['effectiveDate' => $effectiveDate, 'endDate' => $endDate, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy],
@@ -2388,7 +2451,7 @@ public function queryJurisNames($country, $region, $effectiveDate, $endDate, $fi
* @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
* @return \stdClass
*/
- public function queryRateOptions($country, $region, $effectiveDate, $endDate, $aggregationOption, $top=null, $skip=null, $filter=null, $orderBy=null) {
+ public function queryRateOptions($country, $region, $effectiveDate=null, $endDate=null, $aggregationOption=null, $top=null, $skip=null, $filter=null, $orderBy=null) {
$path = "/api/v2/compliance/rateOptions/{$country}/{$region}";
$guzzleParams = [
'query' => ['effectiveDate' => $effectiveDate, 'endDate' => $endDate, 'aggregationOption' => $aggregationOption, '$top' => $top, '$skip' => $skip, '$filter' => $filter, '$orderBy' => $orderBy],
@@ -2440,7 +2503,7 @@ public function queryStateConfig($filter=null, $top=null, $skip=null, $orderBy=n
* @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
* @return \stdClass
*/
- public function queryStateReportingCodes($country, $region, $effectiveDate, $endDate, $filter=null, $top=null, $skip=null, $orderBy=null) {
+ public function queryStateReportingCodes($country, $region, $effectiveDate=null, $endDate=null, $filter=null, $top=null, $skip=null, $orderBy=null) {
$path = "/api/v2/compliance/stateReportingCodes/{$country}/{$region}";
$guzzleParams = [
'query' => ['effectiveDate' => $effectiveDate, 'endDate' => $endDate, '$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy],
@@ -2559,7 +2622,7 @@ public function getContact($companyId, $id) {
* 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 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:* scsContactId
* @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`.
@@ -2589,7 +2652,7 @@ public function listContactsByCompany($companyId, $filter=null, $top=null, $skip
* * 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 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:* scsContactId
* @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`.
@@ -2642,7 +2705,7 @@ public function updateContact($companyId, $id, $model) {
* @param CostCenterBulkUploadInputModel $model The cost center bulk upload model.
* @return \stdClass
*/
- public function bulkUploadCostCenters($companyid, $model) {
+ public function bulkUploadCostCenters($companyid, $model=null) {
$path = "/api/v2/companies/{$companyid}/costcenters/$upload";
$guzzleParams = [
'query' => [],
@@ -2663,7 +2726,7 @@ public function bulkUploadCostCenters($companyid, $model) {
* @param CostCenterRequestModel $model The cost center you wish to create.
* @return \stdClass
*/
- public function createCostCenter($companyid, $model) {
+ public function createCostCenter($companyid, $model=null) {
$path = "/api/v2/companies/{$companyid}/costcenters";
$guzzleParams = [
'query' => [],
@@ -2766,7 +2829,7 @@ public function queryCostCenters($filter=null, $include=null, $top=null, $skip=n
* @param CostCenterRequestModel $model The cost center object you wish to update.
* @return \stdClass
*/
- public function updateCostCenter($companyid, $costcenterid, $model) {
+ public function updateCostCenter($companyid, $costcenterid, $model=null) {
$path = "/api/v2/companies/{$companyid}/costcenters/{$costcenterid}";
$guzzleParams = [
'query' => [],
@@ -2861,9 +2924,16 @@ public function deleteCustomer($companyId, $customerCode) {
*
* You can use the `$include` parameter to fetch the following additional objects for expansion:
*
- * * Certificates - Fetch a list of certificates linked to this customer.
- * * CustomFields - Fetch a list of custom fields associated to this customer.
+ * * certificates - Fetch a list of certificates linked to this customer.
* * attributes - Retrieves all attributes applied to the customer.
+ * * active_certificates - Retrieves all the active certificates linked to this customer
+ * * histories - Retrieves the update history for this customer
+ * * logs - Retrieves customer logs
+ * * jobs - Retrieves customer jobs
+ * * billTos - Retrieves bill-tos linked with this customer
+ * * shipTos - Retrieves ship-tos linked with this customer
+ * * shipToStates - Retrieves ship-to states for this customer
+ * * custom_fields - Retrieves custom fields set for this customer
*
* Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
* Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -3064,7 +3134,7 @@ public function listAttributesForCustomer($companyId, $customerCode) {
*
* @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 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 $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. * histories - Retrieves the certificate update history * jobs - Retrieves the jobs for this certificate * logs - Retrieves the certificate log * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid * custom_fields - Retrieves custom fields set for this certificate
* @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, ecmStatus, 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.
@@ -3133,9 +3203,17 @@ public function listValidCertificatesForCustomer($companyId, $customerCode, $cou
*
* You can use the `$include` parameter to fetch the following additional objects for expansion:
*
- * * Certificates - Fetch a list of certificates linked to this customer.
+ * * certificates - Fetch a list of certificates linked to this customer.
* * attributes - Retrieves all attributes applied to the customer.
- *
+ * * active_certificates - Retrieves all the active certificates linked to this customer
+ * * histories - Retrieves the update history for this customer
+ * * logs - Retrieves customer logs
+ * * jobs - Retrieves customer jobs
+ * * billTos - Retrieves bill-tos linked with this customer
+ * * shipTos - Retrieves ship-tos linked with this customer
+ * * shipToStates - Retrieves ship-to states for this customer
+ * * custom_fields - Retrieves custom fields set for this customer
+ *
* Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
* Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
* certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
@@ -3148,7 +3226,7 @@ public function listValidCertificatesForCustomer($companyId, $customerCode, $cou
* 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 $include OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.
* @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.
@@ -3549,7 +3627,7 @@ public function listAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=n
* @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) {
+ public function listCertificateAttributes($companyid=null, $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],
@@ -3972,7 +4050,7 @@ public function listJurisdictions($filter=null, $top=null, $skip=null, $orderBy=
* @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) {
+ public function listJurisdictionsByAddress($line1=null, $line2=null, $line3=null, $city=null, $region=null, $postalCode=null, $country=null, $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],
@@ -4005,7 +4083,7 @@ public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $regio
* @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) {
+ public function listJurisdictionsByRateTypeTaxTypeMapping($country, $taxTypeId, $taxSubTypeId, $rateTypeId, $region=null, $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],
@@ -4086,7 +4164,7 @@ public function listJurisdictionTypesByRateTypeTaxTypeMapping($country, $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 listLocationQuestionsByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $latitude, $longitude, $filter=null, $top=null, $skip=null, $orderBy=null) {
+ public function listLocationQuestionsByAddress($line1=null, $line2=null, $line3=null, $city=null, $region=null, $postalCode=null, $country=null, $latitude=null, $longitude=null, $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],
@@ -4185,7 +4263,7 @@ public function listNexus($filter=null, $top=null, $skip=null, $orderBy=null)
* @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) {
+ public function listNexusByAddress($line1=null, $line2=null, $line3=null, $city=null, $region=null, $postalCode=null, $country=null, $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],
@@ -5458,7 +5536,7 @@ public function updateDistanceThreshold($companyId, $id, $model) {
* @param DomainNameViewModel $model
* @return \stdClass
*/
- public function createDcv($model) {
+ public function createDcv($model=null) {
$path = "/api/v2/domain-control-verifications";
$guzzleParams = [
'query' => [],
@@ -5503,6 +5581,88 @@ public function getDcvById($domainControlVerificationId) {
return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION );
}
+ /**
+ * Delete AFC event notifications.
+ *
+ * ### Security Policies
+ *
+ * * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+ * Swagger Name: AvaTaxClient
+ *
+ * @param boolean $isDlq Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`.
+ * @param EventDeleteMessageModel $model Details of the event you want to delete.
+ * @return \stdClass
+ */
+ public function deleteAfcEventNotifications($isDlq=null, $model=null) {
+ $path = "/api/v2/event-notifications/afc";
+ $guzzleParams = [
+ 'query' => ['isDlq' => null === $isDlq ? null : json_encode($isDlq)],
+ 'body' => json_encode($model)
+ ];
+ return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION );
+ }
+
+ /**
+ * Delete company event notifications
+ *
+ * ### Security Policies
+ *
+ * * This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.
+ * Swagger Name: AvaTaxClient
+ *
+ * @param int $companyId The unique ID number of the company that recorded these event notifications.
+ * @param EventDeleteMessageModel $model Details of the event you want to delete.
+ * @return \stdClass
+ */
+ public function deleteEventNotifications($companyId, $model) {
+ $path = "/api/v2/event-notifications/companies/{$companyId}";
+ $guzzleParams = [
+ 'query' => [],
+ 'body' => json_encode($model)
+ ];
+ return $this->restCall($path, 'DELETE', $guzzleParams, AVATAX_SDK_VERSION );
+ }
+
+ /**
+ * Retrieve company event notifications.
+ *
+ * ### Security Policies
+ *
+ * * This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.
+ * Swagger Name: AvaTaxClient
+ *
+ * @param int $companyId The unique ID number of the company that recorded these event notifications.
+ * @return \stdClass
+ */
+ public function getEventNotifications($companyId) {
+ $path = "/api/v2/event-notifications/companies/{$companyId}";
+ $guzzleParams = [
+ 'query' => [],
+ 'body' => null
+ ];
+ return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION );
+ }
+
+ /**
+ * Retrieve AFC event notifications
+ *
+ * ### Security Policies
+ *
+ * * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+ * Swagger Name: AvaTaxClient
+ *
+ * @param boolean $isDlq Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`.
+ * @return \stdClass
+ */
+ public function listAfcEventNotifications($isDlq=null) {
+ $path = "/api/v2/event-notifications/afc";
+ $guzzleParams = [
+ 'query' => ['isDlq' => null === $isDlq ? null : json_encode($isDlq)],
+ 'body' => null
+ ];
+ return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION );
+ }
+
/**
* Create a new eCommerce token.
*
@@ -5787,7 +5947,7 @@ public function revokeFirmClientLinkage($id) {
* @param string $subscriptionType The company's subscription type (See POASubscriptionType::* for a list of allowable values)
* @return \stdClass
*/
- public function activateFundingRequest($id, $businessUnit, $subscriptionType) {
+ public function activateFundingRequest($id, $businessUnit=null, $subscriptionType=null) {
$path = "/api/v2/fundingrequests/{$id}/widget";
$guzzleParams = [
'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType],
@@ -5821,7 +5981,7 @@ public function activateFundingRequest($id, $businessUnit, $subscriptionType)
* @param string $subscriptionType The company's subscription type (See POASubscriptionType::* for a list of allowable values)
* @return \stdClass
*/
- public function fundingRequestStatus($id, $businessUnit, $subscriptionType) {
+ public function fundingRequestStatus($id, $businessUnit=null, $subscriptionType=null) {
$path = "/api/v2/fundingrequests/{$id}";
$guzzleParams = [
'query' => ['businessUnit' => $businessUnit, 'subscriptionType' => $subscriptionType],
@@ -5840,7 +6000,7 @@ public function fundingRequestStatus($id, $businessUnit, $subscriptionType) {
* @param GLAccountBulkUploadInputModel $model The GL account bulk upload model.
* @return \stdClass
*/
- public function bulkUploadGLAccounts($companyid, $model) {
+ public function bulkUploadGLAccounts($companyid, $model=null) {
$path = "/api/v2/companies/{$companyid}/glaccounts/$upload";
$guzzleParams = [
'query' => [],
@@ -5861,7 +6021,7 @@ public function bulkUploadGLAccounts($companyid, $model) {
* @param GLAccountRequestModel $model The GL Account you want to create
* @return \stdClass
*/
- public function createGLAccount($companyid, $model) {
+ public function createGLAccount($companyid, $model=null) {
$path = "/api/v2/companies/{$companyid}/glaccounts";
$guzzleParams = [
'query' => [],
@@ -5942,7 +6102,7 @@ public function listGLAccountsByCompany($companyid, $filter=null, $include=null,
* @param GLAccountRequestModel $model The GL account object you want to update
* @return \stdClass
*/
- public function updateGLAccount($companyid, $glaccountid, $model) {
+ public function updateGLAccount($companyid, $glaccountid, $model=null) {
$path = "/api/v2/companies/{$companyid}/glaccounts/{$glaccountid}";
$guzzleParams = [
'query' => [],
@@ -6125,7 +6285,7 @@ public function createItemParameters($companyId, $itemId, $model) {
* @param ItemModel[] $model The item you wish to create.
* @return \stdClass
*/
- public function createItems($companyId, $processRecommendationsSynchronously, $model) {
+ public function createItems($companyId, $processRecommendationsSynchronously=null, $model=null) {
$path = "/api/v2/companies/{$companyId}/items";
$guzzleParams = [
'query' => ['processRecommendationsSynchronously' => null === $processRecommendationsSynchronously ? null : json_encode($processRecommendationsSynchronously)],
@@ -6178,7 +6338,7 @@ public function createItemTags($companyId, $itemId, $model) {
* @param ItemTaxCodeClassificationRequestInputModel $model The request you wish to create.
* @return \stdClass
*/
- public function createTaxCodeClassificationRequest($companyId, $model) {
+ public function createTaxCodeClassificationRequest($companyId, $model=null) {
$path = "/api/v2/companies/{$companyId}/classificationrequests/taxcode";
$guzzleParams = [
'query' => [],
@@ -6696,6 +6856,35 @@ public function listItemsByCompany($companyId, $filter=null, $include=null, $top
return $this->restCall($path, 'GET', $guzzleParams, AVATAX_SDK_VERSION );
}
+ /**
+ * Retrieve the parameters by companyId and itemId.
+ *
+ * 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.
+ *
+ * ### 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
+ *
+ * @param int $companyId Company Identifier.
+ * @param int $itemId Item Identifier.
+ * @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, attributeSubType, 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 listRecommendedParameterByCompanyIdAndItemId($companyId, $itemId, $filter=null, $top=null, $skip=null, $orderBy=null) {
+ $path = "/api/v2/definitions/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 all items
*
@@ -6897,7 +7086,7 @@ public function syncItems($companyId, $model) {
* @param ItemModel $model The item object you wish to update.
* @return \stdClass
*/
- public function updateItem($companyId, $id, $isRecommendationSelected, $model) {
+ public function updateItem($companyId, $id, $isRecommendationSelected=null, $model=null) {
$path = "/api/v2/companies/{$companyId}/items/{$id}";
$guzzleParams = [
'query' => ['isRecommendationSelected' => null === $isRecommendationSelected ? null : json_encode($isRecommendationSelected)],
@@ -8124,7 +8313,7 @@ public function declareNexusByAddress($companyId, $model) {
* @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) {
+ public function deleteNexus($companyId, $id, $cascadeDelete=null) {
$path = "/api/v2/companies/{$companyId}/nexus/{$id}";
$guzzleParams = [
'query' => ['cascadeDelete' => null === $cascadeDelete ? null : json_encode($cascadeDelete)],
@@ -8980,7 +9169,7 @@ public function listServiceTypes($filter=null, $top=null, $skip=null, $orderBy=n
* @param SetPasswordModel $model The new password for this user
* @return \stdClass
*/
- public function resetPassword($userId, $isUndoMigrateRequest, $model) {
+ public function resetPassword($userId, $isUndoMigrateRequest=null, $model=null) {
$path = "/api/v2/passwords/{$userId}/reset";
$guzzleParams = [
'query' => ['isUndoMigrateRequest' => null === $isUndoMigrateRequest ? null : json_encode($isUndoMigrateRequest)],
@@ -9210,7 +9399,7 @@ public function initiateExportDocumentLineReport($companyId, $model) {
* @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) {
+ public function listReports($companyId=null, $pageKey=null, $skip=null, $top=null) {
$path = "/api/v2/reports";
$guzzleParams = [
'query' => ['companyId' => $companyId, 'pageKey' => $pageKey, '$skip' => $skip, '$top' => $top],
@@ -9780,7 +9969,7 @@ public function buildTaxContentFile($model) {
* @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) {
+ public function buildTaxContentFileForLocation($companyId, $id, $date=null, $format=null, $partnerId=null, $includeJurisCodes=null) {
$path = "/api/v2/companies/{$companyId}/locations/{$id}/pointofsaledata";
$guzzleParams = [
'query' => ['date' => $date, 'format' => $format, 'partnerId' => $partnerId, 'includeJurisCodes' => null === $includeJurisCodes ? null : json_encode($includeJurisCodes)],
@@ -9842,7 +10031,7 @@ public function buildTaxContentFileForLocation($companyId, $id, $date, $format,
* @param string $region A two character region code which limits results to a specific region.
* @return \stdClass
*/
- public function downloadTaxRatesByZipCode($date, $region) {
+ public function downloadTaxRatesByZipCode($date, $region=null) {
$path = "/api/v2/taxratesbyzipcode/download/{$date}";
$guzzleParams = [
'query' => ['region' => $region],
@@ -9887,7 +10076,7 @@ public function downloadTaxRatesByZipCode($date, $region) {
* @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) {
+ public function taxRatesByAddress($line1, $line2=null, $line3=null, $city=null, $region=null, $postalCode=null, $country=null) {
$path = "/api/v2/taxrates/byaddress";
$guzzleParams = [
'query' => ['line1' => $line1, 'line2' => $line2, 'line3' => $line3, 'city' => $city, 'region' => $region, 'postalCode' => $postalCode, 'country' => $country],
@@ -9957,7 +10146,7 @@ public function taxRatesByPostalCode($country, $postalCode) {
* @param CountryCoefficientsRequestEntity $model The Country Coefficients for specific country you wish to create.
* @return \stdClass
*/
- public function createCountryCoefficients($model) {
+ public function createCountryCoefficients($model=null) {
$path = "/api/v2/countryCoefficients";
$guzzleParams = [
'query' => [],
@@ -10307,7 +10496,7 @@ public function addLines($include=null, $model=null) {
* @param AdjustTransactionModel $model The adjustment you wish to make
* @return \stdClass
*/
- public function adjustTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) {
+ public function adjustTransaction($companyCode, $transactionCode, $documentType=null, $include=null, $model=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/adjust";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -10485,7 +10674,7 @@ public function bulkLockTransaction($model) {
* @param ChangeTransactionCodeModel $model The code change request you wish to execute
* @return \stdClass
*/
- public function changeTransactionCode($companyCode, $transactionCode, $documentType, $include=null, $model=null) {
+ public function changeTransactionCode($companyCode, $transactionCode, $documentType=null, $include=null, $model=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/changecode";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -10539,7 +10728,7 @@ public function changeTransactionCode($companyCode, $transactionCode, $documentT
* @param CommitTransactionModel $model The commit request you wish to execute
* @return \stdClass
*/
- public function commitTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) {
+ public function commitTransaction($companyCode, $transactionCode, $documentType=null, $include=null, $model=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/commit";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -10778,7 +10967,7 @@ public function getAllVarianceReportByCompanyCode($companyCode) {
* @param string $include Specifies objects to include in this fetch call
* @return \stdClass
*/
- public function getTransactionByCode($companyCode, $transactionCode, $documentType, $include=null) {
+ public function getTransactionByCode($companyCode, $transactionCode, $documentType=null, $include=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -10932,7 +11121,7 @@ public function getVarianceReportByCompanyCodeByTransactionId($companyCode, $tra
* @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) {
+ public function listTransactionsByCompany($companyCode, $dataSourceId=null, $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],
@@ -10988,7 +11177,7 @@ public function listTransactionsByCompany($companyCode, $dataSourceId, $include=
* @param LockTransactionModel $model The lock request you wish to execute
* @return \stdClass
*/
- public function lockTransaction($companyCode, $transactionCode, $documentType, $include=null, $model=null) {
+ public function lockTransaction($companyCode, $transactionCode, $documentType=null, $include=null, $model=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/lock";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -11109,7 +11298,7 @@ public function refundTransaction($companyCode, $transactionCode, $include=null,
* @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) {
+ public function settleTransaction($companyCode, $transactionCode, $documentType=null, $include=null, $model=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/settle";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -11157,7 +11346,7 @@ public function settleTransaction($companyCode, $transactionCode, $documentType,
* @param string $include Specifies objects to include in this fetch call
* @return \stdClass
*/
- public function uncommitTransaction($companyCode, $transactionCode, $documentType, $include=null) {
+ public function uncommitTransaction($companyCode, $transactionCode, $documentType=null, $include=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/uncommit";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -11202,7 +11391,7 @@ public function uncommitTransaction($companyCode, $transactionCode, $documentTyp
* @param string $include Specifies objects to include in this fetch call
* @return \stdClass
*/
- public function unvoidTransaction($companyCode, $transactionCode, $documentType, $include=null) {
+ public function unvoidTransaction($companyCode, $transactionCode, $documentType=null, $include=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/unvoid";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -11277,7 +11466,7 @@ public function varianceReport($companyCode, $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) {
+ public function verifyTransaction($companyCode, $transactionCode, $documentType=null, $include=null, $model=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/verify";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -11332,7 +11521,7 @@ public function verifyTransaction($companyCode, $transactionCode, $documentType,
* @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) {
+ public function voidTransaction($companyCode, $transactionCode, $documentType=null, $include=null, $model=null) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/void";
$guzzleParams = [
'query' => ['documentType' => $documentType, '$include' => $include],
@@ -11544,7 +11733,7 @@ public function deleteUserDefinedField($companyId, $id) {
* @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) {
+ public function listUserDefinedFieldsByCompanyId($companyId, $udfType=null, $allowDefaults=null) {
$path = "/api/v2/companies/{$companyId}/userdefinedfields";
$guzzleParams = [
'query' => ['udfType' => $udfType, 'allowDefaults' => null === $allowDefaults ? null : json_encode($allowDefaults)],
@@ -11569,7 +11758,7 @@ public function listUserDefinedFieldsByCompanyId($companyId, $udfType, $allowDef
* @param CompanyUserDefinedFieldModel $model
* @return \stdClass
*/
- public function updateUserDefinedField($companyId, $id, $model) {
+ public function updateUserDefinedField($companyId, $id=null, $model=null) {
$path = "/api/v2/companies/{$companyId}/userdefinedfields";
$guzzleParams = [
'query' => ['id' => $id],
@@ -11997,7 +12186,7 @@ public function storeAgeVerification($model) {
* @param AgeVerifyRequest $model Information about the individual whose age is being verified.
* @return \stdClass
*/
- public function storeIfVerified($simulatedFailureCode, $model) {
+ public function storeIfVerified($simulatedFailureCode=null, $model=null) {
$path = "/api/v2/ageverification/store/identity/storeIfVerified";
$guzzleParams = [
'query' => ['simulatedFailureCode' => $simulatedFailureCode],
@@ -12028,7 +12217,7 @@ public function storeIfVerified($simulatedFailureCode, $model) {
* @param AgeVerifyRequest $model Information about the individual whose age is being verified.
* @return \stdClass
*/
- public function verifyAge($simulatedFailureCode, $model) {
+ public function verifyAge($simulatedFailureCode=null, $model=null) {
$path = "/api/v2/ageverification/verify";
$guzzleParams = [
'query' => ['simulatedFailureCode' => $simulatedFailureCode],
@@ -12050,7 +12239,7 @@ public function verifyAge($simulatedFailureCode, $model) {
* @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= "" ) {
+ public function deregisterShipment($companyCode, $transactionCode, $documentType=null, $api_version= "" , $x_avalara_version= "" ) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration";
$guzzleParams = [
'query' => ['documentType' => $documentType, 'api-version' => $api_version],
@@ -12073,7 +12262,7 @@ public function deregisterShipment($companyCode, $transactionCode, $documentType
* @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= "" ) {
+ public function registerShipment($companyCode, $transactionCode, $documentType=null, $api_version= "" , $x_avalara_version= "" ) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registration";
$guzzleParams = [
'query' => ['documentType' => $documentType, 'api-version' => $api_version],
@@ -12096,7 +12285,7 @@ public function registerShipment($companyCode, $transactionCode, $documentType,
* @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= "" ) {
+ public function registerShipmentIfCompliant($companyCode, $transactionCode, $documentType=null, $api_version= "" , $x_avalara_version= "" ) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/registerIfCompliant";
$guzzleParams = [
'query' => ['documentType' => $documentType, 'api-version' => $api_version],
@@ -12134,7 +12323,7 @@ public function registerShipmentIfCompliant($companyCode, $transactionCode, $doc
* @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= "" ) {
+ public function verifyShipment($companyCode, $transactionCode, $documentType=null, $api_version= "" , $x_avalara_version= "" ) {
$path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/shipment/verify";
$guzzleParams = [
'query' => ['documentType' => $documentType, 'api-version' => $api_version],
@@ -12197,7 +12386,7 @@ public function enqueueBatchRegistration($companyCode, $batchCode, $api_version=
* @param string $accountId (Optional): For users with access to multiple accounts, filters results to those associated with the specified Account ID. If not specified, the Account ID defaults to the one associated with the account
* @return \stdClass
*/
- public function getBatchRegistrationData($accountId) {
+ public function getBatchRegistrationData($accountId=null) {
$path = "/api/v2/asv/batches";
$guzzleParams = [
'query' => ['accountId' => $accountId],
diff --git a/src/Models.php b/src/Models.php
index 1069a8c..14457bb 100644
--- a/src/Models.php
+++ b/src/Models.php
@@ -431,29 +431,29 @@ class ActivateAccountModel
public $haveReadAvalaraTermsAndConditions;
}
/**
- * Certificate with exemption reason and exposure zone. Exposed in url $includes
+ * Certificate with exemption reason and exposure zone. This is exposed in the URL's `$includes`.
* Swagger Name: AvaTaxClient
*/
class ActiveCertificateModel
{
/**
- * @var int Certificate ID.
+ * @var int The unique ID number of this certificate.
*/
public $id;
/**
- * @var string Created date time
+ * @var string The date/time when this certificate was created.
*/
public $created;
/**
- * @var string Modified date time
+ * @var string The date/time when this certificate was last modified.
*/
public $modified;
/**
- * @var string Certificate's expected tax number
+ * @var string The expected tax number for this certificate.
*/
public $expectedTaxNumber;
/**
- * @var string Certificate's actual tax number
+ * @var string The actual tax number for this certificate.
*/
public $actualTaxNumber;
/**
@@ -1601,14 +1601,14 @@ class BatchModel
* @var string The agent used to create this batch
*/
public $batchAgent;
- /**
- * @var string Any optional flags provided for this batch
- */
- public $options;
/**
* @var int The unique ID number of this batch.
*/
public $id;
+ /**
+ * @var string Any optional flags provided for this batch
+ */
+ public $options;
/**
* @var string The user-friendly readable name for this batch.
*/
@@ -1819,52 +1819,52 @@ class CertificateAttributeModel
public $isSystemCode;
}
/**
- * Invalid reason for the certificate
+ * The reason the certificate is invalid.
* Swagger Name: AvaTaxClient
*/
class CertificateInvalidReasonModel
{
/**
- * @var int
+ * @var int The unique ID of this invalid reason.
*/
public $id;
/**
- * @var string
+ * @var string The name of this certificate invalid reason.
*/
public $name;
/**
- * @var string
+ * @var string A description of the certificate invalid reason.
*/
public $description;
/**
- * @var boolean
+ * @var boolean This value is `true` if the invalid reason is a system code.
*/
public $systemCode;
}
/**
- * certificate log for a customer. Exposed in url $includes
+ * The certificate log for a customer. This is exposed in the URL's `$includes`.
* Swagger Name: AvaTaxClient
*/
class CertificateLogModel
{
/**
- * @var int Log ID
+ * @var int The unique ID number of this log entry.
*/
public $id;
/**
- * @var int Certificate ID
+ * @var int The unique ID number of this certificate.
*/
public $certificateId;
/**
- * @var string Account name
+ * @var string The name of this account.
*/
public $account;
/**
- * @var string Log description
+ * @var string The log entry description.
*/
public $entry;
/**
- * @var string Date of creation for log entry
+ * @var string The date/time when this certificate log was created.
*/
public $created;
}
@@ -1878,7 +1878,7 @@ class CertificateLogModel
class CertificateModel
{
/**
- * @var int Unique ID number of this certificate.
+ * @var int The unique ID number of this certificate.
*/
public $id;
/**
@@ -1930,11 +1930,11 @@ class CertificateModel
*/
public $exemptionReason;
/**
- * @var string The status of the certificate
+ * @var string The status of the certificate.
*/
public $status;
/**
- * @var string The status of the certificate as displayed on https://exemptions.avalara.com. Can take values (See CertificateEcmStatus::* for a list of allowable values)
+ * @var string The status of the certificate as displayed on https://exemptions.avalara.com. The values in `CertificateEcmStatus` include all the possible status values. (See CertificateEcmStatus::* for a list of allowable values)
*/
public $ecmStatus;
/**
@@ -1954,7 +1954,7 @@ class CertificateModel
*/
public $businessNumberType;
/**
- * @var int Number of pages contained within this certificate.
+ * @var int The number of pages contained within this certificate.
*/
public $pageCount;
/**
@@ -1974,23 +1974,23 @@ class CertificateModel
*/
public $attributes;
/**
- * @var HistoryModel[] A list of certificate update histories for this certificate. You can fetch this data by specifying `$include=histories` when calling a certificate fetch API.
+ * @var HistoryModel[] A list of update histories for this certificate. You can fetch this data by specifying `$include=histories` when calling a certificate fetch API.
*/
public $histories;
/**
- * @var CustomerJobModel[] A list of certificate update histories for this certificate. You can fetch this data by specifying `$include=jobs` when calling a certificate fetch API.
+ * @var CustomerJobModel[] A list of jobs for this certificate. You can fetch this data by specifying `$include=jobs` when calling a certificate fetch API.
*/
public $jobs;
/**
- * @var CertificateLogModel[] A list of certificate logs for this certificate. You can fetch this data by specifying `$include=logs` when calling a certificate fetch API.
+ * @var CertificateLogModel[] A list of logs for this certificate. You can fetch this data by specifying `$include=logs` when calling a certificate fetch API.
*/
public $logs;
/**
- * @var CertificateInvalidReasonModel[] A list of invalid reasons if the certificate status is not valid You can fetch this data by specifying `$include=invalid_reasons` when calling a certificate fetch API.
+ * @var CertificateInvalidReasonModel[] For a certificate with an invalid status, this lists the reasons why the certificate is invalid. You can fetch this data by specifying `$include=invalid_reasons` when calling a certificate fetch API.
*/
public $invalidReasons;
/**
- * @var CustomFieldModel[] A list of custom defined fields for this certificate You can fetch this data by specifying `$include=custom_fields` when calling a certificate fetch API.
+ * @var CustomFieldModel[] A list of custom defined fields for this certificate. You can fetch this data by specifying `$include=custom_fields` when calling a certificate fetch API.
*/
public $customFields;
/**
@@ -2150,6 +2150,144 @@ class CommitTransactionModel
*/
public $commit;
}
+/**
+ * Encloses communication certificate details
+ * Swagger Name: AvaTaxClient
+ */
+class CommunicationCertificateResponse
+{
+ /**
+ * @var int Certificate Id
+ */
+ public $id;
+ /**
+ * @var string Certificate effective date
+ */
+ public $effectiveDate;
+ /**
+ * @var string Certificate expiration date
+ */
+ public $expirationDate;
+ /**
+ * @var string Certificate exemption reason
+ */
+ public $exemptionReason;
+ /**
+ * @var string Certificate exemption region
+ */
+ public $exemptionRegion;
+ /**
+ * @var string Certificate tax number
+ */
+ public $taxNumber;
+ /**
+ * @var string Certificate status
+ */
+ public $certificateStatus;
+ /**
+ * @var CommunicationCustomerResponse[] Customers which have this certificate
+ */
+ public $customers;
+ /**
+ * @var CommunicationTaxTypeResponse[] Tax details of this certificate
+ */
+ public $exemptions;
+}
+/**
+ * Encloses count and model value details
+ * Swagger Name: AvaTaxClient
+ */
+class CommunicationCertificateResponsePage
+{
+ /**
+ * @var int Count of records
+ */
+ public $count;
+ /**
+ * @var CommunicationCertificateResponse[] Requested model list
+ */
+ public $value;
+}
+/**
+ * Encloses communication certificate customer
+ * Swagger Name: AvaTaxClient
+ */
+class CommunicationCustomerResponse
+{
+ /**
+ * @var int Customer Id
+ */
+ public $id;
+ /**
+ * @var string Customer number
+ */
+ public $customerNumber;
+}
+/**
+ * Encloses Communication exemption designator details
+ * Swagger Name: AvaTaxClient
+ */
+class CommunicationExemptionDesignatorResponse
+{
+ /**
+ * @var int Communication category Id
+ */
+ public $id;
+ /**
+ * @var string Tax category
+ */
+ public $type;
+ /**
+ * @var string Communication category name
+ */
+ public $name;
+}
+/**
+ * Encloses communication location details
+ * Swagger Name: AvaTaxClient
+ */
+class CommunicationLocationResponse
+{
+ /**
+ * @var string Communication tax country
+ */
+ public $country;
+ /**
+ * @var string Communication tax state
+ */
+ public $state;
+ /**
+ * @var string Communication tax County
+ */
+ public $county;
+ /**
+ * @var string Communication tax city
+ */
+ public $city;
+}
+/**
+ * Encloses communication tax type details
+ * Swagger Name: AvaTaxClient
+ */
+class CommunicationTaxTypeResponse
+{
+ /**
+ * @var CommunicationLocationResponse
+ */
+ public $location;
+ /**
+ * @var CommunicationExemptionDesignatorResponse
+ */
+ public $exemptionDesignator;
+ /**
+ * @var string[] Communication scope
+ */
+ public $scope;
+ /**
+ * @var string Communication domain
+ */
+ public $domain;
+}
/**
* Represents a transaction/service type pair for telecommunications tax
* Swagger Name: AvaTaxClient
@@ -3790,6 +3928,10 @@ class CreateTransactionBatchRequestModel
* @var TransactionBatchItemModel[] The list of transactions contained in this batch.
*/
public $transactions;
+ /**
+ * @var string Any optional flags provided for this batch
+ */
+ public $options;
}
/**
* Represents a create transaction batch response model.
@@ -3801,6 +3943,10 @@ class CreateTransactionBatchResponseModel
* @var int The unique ID number of this batch.
*/
public $id;
+ /**
+ * @var string Any optional flags provided for this batch
+ */
+ public $options;
/**
* @var string The user-friendly readable name for this batch.
*/
@@ -3997,6 +4143,68 @@ class CreateTransactionModel
*/
public $deliveryTerms;
}
+/**
+ * Credit Transaction Detail Lines
+ * Swagger Name: AvaTaxClient
+ */
+class CreditTransactionDetailLines
+{
+ /**
+ * @var string ReportingDate
+ */
+ public $reportingDate;
+ /**
+ * @var string LineNo
+ */
+ public $lineNo;
+ /**
+ * @var float LineAmount
+ */
+ public $lineAmount;
+ /**
+ * @var float ExemptAmount
+ */
+ public $exemptAmount;
+ /**
+ * @var float TaxableAmount
+ */
+ public $taxableAmount;
+ /**
+ * @var float TaxAmount
+ */
+ public $taxAmount;
+}
+/**
+ * Credit Transaction Details
+ * Swagger Name: AvaTaxClient
+ */
+class CreditTransactionDetails
+{
+ /**
+ * @var string DocCode
+ */
+ public $docCode;
+ /**
+ * @var string DocDate
+ */
+ public $docDate;
+ /**
+ * @var float TotalExempt
+ */
+ public $totalExempt;
+ /**
+ * @var float TotalTaxable
+ */
+ public $totalTaxable;
+ /**
+ * @var float TotalTax
+ */
+ public $totalTax;
+ /**
+ * @var CreditTransactionDetailLines[] Lines
+ */
+ public $lines;
+}
/**
* Represents an ISO 4217 currency code used for designating the currency of a transaction.
* Swagger Name: AvaTaxClient
@@ -4028,7 +4236,7 @@ class CurrencyModel
class CustomFieldModel
{
/**
- * @var int Custom field ID
+ * @var int The unique ID of this custom field.
*/
public $id;
/**
@@ -4036,19 +4244,19 @@ class CustomFieldModel
*/
public $name;
/**
- * @var string Custom field type
+ * @var string The type of custom field.
*/
public $type;
/**
- * @var string
+ * @var string The possible values the custom field can have.
*/
public $possibleValues;
/**
- * @var boolean Custom field uses data entry or not?
+ * @var boolean This value is `true` if the custom field uses a data entry.
*/
public $usesDataEntry;
/**
- * @var boolean Custom field is required in data entry or not?
+ * @var boolean Shows whether the custom field is required in data entry.
*/
public $requiredInDataEntry;
/**
@@ -4089,21 +4297,21 @@ class CustomerAttributeModel
public $isChangeable;
}
/**
- * Customer job model. Exposed in url $includes
+ * Customer job model. This is exposed in the URL's `$includes`.
* Swagger Name: AvaTaxClient
*/
class CustomerJobModel
{
/**
- * @var int ID
+ * @var int The unique ID number of this customer's job.
*/
public $id;
/**
- * @var int Job number
+ * @var int The job number of this customer.
*/
public $jobNumber;
/**
- * @var string Job name
+ * @var string The job name of this customer.
*/
public $name;
}
@@ -4114,7 +4322,7 @@ class CustomerJobModel
class CustomerModel
{
/**
- * @var int Unique ID number of this customer.
+ * @var int The unique ID number of this customer.
*/
public $id;
/**
@@ -4226,23 +4434,23 @@ class CustomerModel
*/
public $attributes;
/**
- * @var ActiveCertificateModel[] List if active certificates with exemption reasons
+ * @var ActiveCertificateModel[] A list of active certificates with exemption reasons.
*/
public $activeCertificates;
/**
- * @var HistoryModel[] List of field update histories for this customer
+ * @var HistoryModel[] A list of field update histories for this customer.
*/
public $histories;
/**
- * @var CustomerJobModel[] List of jobs for this customer
+ * @var CustomerJobModel[] A list of jobs for this customer.
*/
public $jobs;
/**
- * @var CertificateLogModel[] List of logs for this customer
+ * @var CertificateLogModel[] A list of logs for this customer.
*/
public $logs;
/**
- * @var StateModel[] List of states where this customer ships to
+ * @var StateModel[] A list of states where this customer ships to.
*/
public $shipToStates;
}
@@ -5255,6 +5463,51 @@ class ErrorTransactionOutputModel
*/
public $documentCode;
}
+/**
+ * Model to delete message
+ * Swagger Name: AvaTaxClient
+ */
+class EventDeleteBatchMessageModel
+{
+ /**
+ * @var string The receipt handle associated with the message to delete.
+ */
+ public $receiptHandle;
+ /**
+ * @var string A system-assigned message ID
+ */
+ public $messageId;
+}
+/**
+ * Encloses the delete message command.
+ * Swagger Name: AvaTaxClient
+ */
+class EventDeleteMessageModel
+{
+ /**
+ * @var EventDeleteBatchMessageModel[] Command details for the delete message
+ */
+ public $eventDeleteBatchMessageCommands;
+}
+/**
+ * Encloses event message details
+ * Swagger Name: AvaTaxClient
+ */
+class EventMessageResponse
+{
+ /**
+ * @var string Message content
+ */
+ public $body;
+ /**
+ * @var string A system-assigned message ID
+ */
+ public $messageId;
+ /**
+ * @var string The receipt handle associated with the message to delete.
+ */
+ public $receiptHandle;
+}
/**
* An exemption reason defines why a certificate allows a customer to be exempt
* for purposes of tax calculation. For a full list of defined exemption reasons,
@@ -5860,6 +6113,10 @@ class FilingCalendarModel
* @var int Auto Lock Override Day
*/
public $autoLockOverrideDay;
+ /**
+ * @var string The three-character currency code according to country. For example if country is 'US' then currency is 'USD'. Similarly, if country is 'CA' then currency is 'CAD', etc.
+ */
+ public $currency;
}
/**
* FilingFrequency Model
@@ -6216,7 +6473,7 @@ class FilingReturnCreditModel
*/
public $totalTax;
/**
- * @var WorksheetDocument[] The excluded carry over credit documents
+ * @var CreditTransactionDetails[] The excluded carry over credit documents
*/
public $transactionDetails;
}
@@ -6450,6 +6707,14 @@ class FilingReturnModel
* @var FilingReturnCreditModel
*/
public $appliedCarryOverCredits;
+ /**
+ * @var string The three-character liability currency code.
+ */
+ public $liabilityCurrencyCode;
+ /**
+ * @var string The three-character filing calendar currency code for this return. For example if country is 'US' then currency is 'USD'. Similarly, if country is 'CA' then currency is 'CAD', etc.
+ */
+ public $filingCalendarCurrencyCode;
/**
* @var string The date when this record was created.
*/
@@ -7446,6 +7711,14 @@ class FundingInitiateModel
* @var boolean Set this value to true to request an HTML-based funding widget that can be embedded within an existing user interface. A user can then interact with the HTML-based funding widget to set up funding information for the company.
*/
public $requestWidget;
+ /**
+ * @var string Currency
+ */
+ public $currency;
+ /**
+ * @var string AgreementType
+ */
+ public $agreementType;
}
/**
* Status of an Avalara Managed Returns funding configuration for a company
@@ -7630,33 +7903,33 @@ class GLAccountUploadErrorModel
public $errors;
}
/**
- * Update history for Avalara.AvaTax.AccountServices.Models.v2.CustomerModel and Avalara.AvaTax.AccountServices.Models.v2.CertificateModel. Exposed in url $includes
+ * Update history for Avalara.AvaTax.AccountServices.Models.v2.CustomerModel and Avalara.AvaTax.AccountServices.Models.v2.CertificateModel. This is exposed in the URL's `$includes`.
* Swagger Name: AvaTaxClient
*/
class HistoryModel
{
/**
- * @var int ID
+ * @var int The unique ID number of this history.
*/
public $id;
/**
- * @var string Account name whose history this is
+ * @var string The account name this history belongs to.
*/
public $account;
/**
- * @var string Field name which is updated
+ * @var string The name of the field to update.
*/
public $field;
/**
- * @var string Old value of the field
+ * @var string The old value of the field.
*/
public $oldValue;
/**
- * @var string New value of the field
+ * @var string The new value of the field.
*/
public $newValue;
/**
- * @var string Date of creation of this history object
+ * @var string The date/time when this history was created.
*/
public $created;
}
@@ -7923,11 +8196,11 @@ class ItemCatalogueInputModel
*/
public $itemType;
/**
- * @var string The universal product code of the item.
+ * @var string The universal product code of the item. Deprecated - As of 6/25/2024, this field is deprecated. Instead of using this field, you can pass this value as a parameter. The parameter name is UPC.
*/
public $upc;
/**
- * @var string A summary for selection of the tax code.
+ * @var string Long Summary for Item Deprecated - As of 6/25/2024, this field is deprecated. Instead of using this field, you can pass this value as a parameter. The parameter name is Summary.
*/
public $summary;
/**
@@ -7943,7 +8216,7 @@ class ItemCatalogueInputModel
*/
public $source;
/**
- * @var string The Id of this item at the source
+ * @var string The unique identifier of this item at the source
*/
public $sourceEntityId;
/**
@@ -7951,7 +8224,7 @@ class ItemCatalogueInputModel
*/
public $properties;
/**
- * @var ClassificationModel[] Classifications Attached to the Product
+ * @var ClassificationModel[] Classifications Attached to the Product Please note: `taxCode` (ProductCode for SystemCode `AVATAXCODE`) is being removed from `classifications`. You can still find it in the `taxCode` field.
*/
public $classifications;
/**
@@ -7989,7 +8262,7 @@ class ItemCatalogueResultModel
*/
public $itemCode;
/**
- * @var string The Id of this item at the source
+ * @var string The unique identifier of this item at the source
*/
public $sourceEntityId;
/**
@@ -8106,7 +8379,7 @@ class ItemModel
*/
public $source;
/**
- * @var string The Id of this item at the source
+ * @var string The unique identifier of this item at the source
*/
public $sourceEntityId;
/**
@@ -8114,15 +8387,15 @@ class ItemModel
*/
public $itemType;
/**
- * @var string Universal unique code for item
+ * @var string Universal unique code for item Deprecated - As of 6/25/2024, this field is deprecated. Instead of using this field, you can pass this value as a parameter. `The parameter name is UPC`.
*/
public $upc;
/**
- * @var string Long Summary for Item
+ * @var string Long Summary for Item Deprecated - As of 6/25/2024, this field is deprecated. Instead of using this field, you can pass this value as a parameter. `The parameter name is Summary`.
*/
public $summary;
/**
- * @var ClassificationModel[] List of classifications that belong to this item. A single classification consists of a productCode and a systemCode for a particular item.
+ * @var ClassificationModel[] List of classifications that belong to this item. A single classification consists of a productCode and a systemCode for a particular item. Please note: `taxCode` (ProductCode for SystemCode `AVATAXCODE`) is being removed from `classifications`. You can still find it in the `taxCode` field.
*/
public $classifications;
/**
@@ -9472,41 +9745,6 @@ class MarketplaceModel
*/
public $marketplace;
}
-/**
- *
- * Swagger Name: AvaTaxClient
- */
-class Message
-{
- /**
- * @var string
- */
- public $details;
- /**
- * @var string
- */
- public $helpLink;
- /**
- * @var string
- */
- public $name;
- /**
- * @var string
- */
- public $refersTo;
- /**
- * @var string
- */
- public $severity;
- /**
- * @var string
- */
- public $source;
- /**
- * @var string
- */
- public $summary;
-}
/**
* A company and account
* Swagger Name: AvaTaxClient
@@ -9869,6 +10107,14 @@ class MultiTaxFilingReturnModel
* @var string The FilingTaskType for this return.
*/
public $type;
+ /**
+ * @var string The three-character liability currency code.
+ */
+ public $liabilityCurrencyCode;
+ /**
+ * @var string The three-character filing calendar currency code for this return. For example if country is 'US' then currency is 'USD'. Similarly, if country is 'CA' then currency is 'CAD', etc.
+ */
+ public $filingCalendarCurrencyCode;
/**
* @var FilingsTaxSummaryModel
*/
@@ -13699,7 +13945,7 @@ class TransactionLineDetailModel
*/
public $taxTypeGroupId;
/**
- * @var string The name of the tax against which this tax amount was calculated.
+ * @var string The name of the tax against which this tax amount was calculated. Note: This output field is informational, and the values in this field may change. As such, we discourage hardcoding any string matching on this field.
*/
public $taxName;
/**
@@ -14356,7 +14602,7 @@ class TransactionModel
*/
public $deliveryTerms;
/**
- * @var string Users can set tolerance or threshold limits on transactions and inform users of appropriate actions to take if a transaction falls outside of these values. An Accounts Payable (AP) status code indicates the action that needs to be taken when the tolerance/threshold falls above or below the tolerance/threshold limits. Available AP status codes are: 1. NoAccrualMatch 2. NoAccrualUndercharge 3. NoAccrualOvercharge 4. NoAccrualAmountThresholdNotMet 5. NoAccrualTrustedVendor 6. NoAccrualExemptedCostCenter 7. NoAccrualExemptedItem 8. NoAccrualExemptedVendor 9. AccruedUndercharge 10. AccruedVendor 11. NeedReviewUndercharge 12. NeedReviewVendor 13. PendingAccrualVendor 14. PendingAccrualUndercharge (See APStatus::* for a list of allowable values)
+ * @var string Users can set tolerance or threshold limits on transactions and inform users of appropriate actions to take if a transaction falls outside of these values. An Accounts Payable (AP) status code indicates the action that needs to be taken when the tolerance/threshold falls above or below the tolerance/threshold limits. Available AP status codes are: 1. NoAccrualMatch 2. NoAccrualUndercharge 3. NoAccrualOvercharge 4. NoAccrualAmountThresholdNotMet 5. NoAccrualTrustedVendor 6. NoAccrualExemptedCostCenter 7. NoAccrualExemptedItem 8. NoAccrualExemptedVendor 9. NoAccrualRejectMatch 10. NoAccrualRejectUndercharge 11. NoAccrualShortPayAvalaraCalculated 12. NoAccrualRejectOvercharge 13. NoAccrualExemptedGLAccount 14. AccruedUndercharge 15. AccruedVendor 16. AccruedShortPayItemsMatch 17. AccruedShortPayItemsUndercharge 18. AccruedShortPayItemsOvercharge 19. NeedReviewUndercharge 20. NeedReviewVendor 21. NeedReviewMatch 22. NeedReviewOvercharge 23. PendingAccrualVendor 24. PendingAccrualUndercharge 25. PendingShortPayItemsUndercharge 26. PendingShortPayItemsMatch 27. PendingShortPayItemsOvercharge (See APStatus::* for a list of allowable values)
*/
public $apStatusCode;
/**
@@ -15090,92 +15336,6 @@ class VoidTransactionModel
*/
public $code;
}
-/**
- *
- * Swagger Name: AvaTaxClient
- */
-class WorksheetDocument
-{
- /**
- * @var string
- */
- public $docCode;
- /**
- * @var string
- */
- public $docDate;
- /**
- * @var float
- */
- public $totalExempt;
- /**
- * @var float
- */
- public $totalTaxable;
- /**
- * @var float
- */
- public $totalTax;
- /**
- * @var WorksheetDocumentLine[]
- */
- public $lines;
- /**
- * @var Message[]
- */
- public $messages;
- /**
- * @var string
- */
- public $resultCode;
- /**
- * @var string
- */
- public $transactionId;
-}
-/**
- *
- * Swagger Name: AvaTaxClient
- */
-class WorksheetDocumentLine
-{
- /**
- * @var string
- */
- public $reportingDate;
- /**
- * @var string
- */
- public $lineNo;
- /**
- * @var float
- */
- public $lineAmount;
- /**
- * @var float
- */
- public $exemptAmount;
- /**
- * @var float
- */
- public $taxableAmount;
- /**
- * @var float
- */
- public $taxAmount;
- /**
- * @var Message[]
- */
- public $messages;
- /**
- * @var string
- */
- public $resultCode;
- /**
- * @var string
- */
- public $transactionId;
-}
/**
* Represents a verification request using Skyscraper for a company
* Swagger Name: AvaTaxClient