From ad4b0753ae1a6cad7302b5a8927430f7f8a49760 Mon Sep 17 00:00:00 2001 From: contygm Date: Thu, 16 Jul 2020 22:17:59 +0000 Subject: [PATCH 1/3] 20.7.0 update --- src/Client.php | 4 +- src/Constants.php | 1762 ++------------------------------------------- src/Methods.php | 113 ++- src/Models.php | 80 +- 4 files changed, 241 insertions(+), 1718 deletions(-) diff --git a/src/Client.php b/src/Client.php index 1765631..60c4bd6 100644 --- a/src/Client.php +++ b/src/Client.php @@ -168,13 +168,13 @@ protected function restCall($apiUrl, $verb, $guzzleParams) } $guzzleParams['headers'] = [ 'Accept' => 'application/json', - 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; 20.6.0; {$this->machineName}" + 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; 20.7.0; {$this->machineName}" ]; } else { $guzzleParams['headers'] = [ 'Accept' => 'application/json', 'Authorization' => 'Bearer '.$this->auth[0], - 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; 20.6.0; {$this->machineName}" + 'X-Avalara-Client' => "{$this->appName}; {$this->appVersion}; PhpRestClient; 20.7.0; {$this->machineName}" ]; } // timeout for 1200s (20 min) diff --git a/src/Constants.php b/src/Constants.php index 4535582..05ce4ff 100644 --- a/src/Constants.php +++ b/src/Constants.php @@ -27,235 +27,66 @@ class TransactionAddressType /** - * Casing to use for validation result + * */ class TextCase { - - /** - * Upper case - */ const C_UPPER = 0; - - /** - * Mixed Case - */ const C_MIXED = 1; } /** - * Represents the different types of transactions that AvaTax can process. + * */ class DocumentType { - - /** - * Represents an estimate, or a sales order, or a quote. - * - * This document type is used before a sale has occurred to estimate the final amount of tax to be paid when the - * sale is completed. - * - * For a sales order, the `companyCode` of the transaction refers to the seller and the `customerVendorCode` refers to the buyer. - * - * This is a temporary document type and is not saved in tax history. - */ const C_SALESORDER = 0; - - /** - * Represents a sale that has been finalized. - * - * This document type is used to record a final transaction and calculate the final tax amount with all necessary information. - * - * For a sales invoice, the `companyCode` of the transaction refers to the seller and the `customerVendorCode` refers to the buyer. - * - * This is a permanent document and is recorded in AvaTax. - */ const C_SALESINVOICE = 1; - - /** - * Represents an estimate, or a purchase order, or a quote. - * - * This document type is used before a sale has occurred to estimate the final amount of tax to be paid when the - * sale is completed. - * - * For a purchase order, the `companyCode` of the transaction refers to the buyer and the `customerVendorCode` refers to the seller. - * - * This is a temporary document type and is not saved in tax history. - */ const C_PURCHASEORDER = 2; - - /** - * Represents a sale that has been finalized. - * - * This document type is used to record a final transaction and calculate the final tax amount with all necessary information. - * - * For a purchase invoice, the `companyCode` of the transaction refers to the buyer and the `customerVendorCode` refers to the seller. - * - * This is a permanent document and is recorded in AvaTax. - */ const C_PURCHASEINVOICE = 3; - - /** - * Represents an estimate of tax to be refunded if a refund or return is processed. - * - * This document type is used before a customer chooses to request a refund for a previous sale, and it - * estimates the final amount of tax to be refunded when the refund is completed. - * - * For a return order, the `companyCode` of the transaction refers to the seller who is giving the refund - * and the `customerVendorCode` refers to the buyer who is requesting the refund. - * - * This is a temporary document type and is not saved in tax history. - */ const C_RETURNORDER = 4; - - /** - * Represents an refund that has been finalized. - * - * This document type is used when a customer chooses to request a refund for a previous sale, and it - * records the final amount of tax that has been refunded when the refund is completed. - * - * For a return invoice, the `companyCode` of the transaction refers to the seller who is giving the refund - * and the `customerVendorCode` refers to the buyer who is requesting the refund. - * - * This is a permanent document and is recorded in AvaTax. - * - * Please note that many jurisdictions around the United States have special rules about how to report refunds - * on a sales tax filing, and some refund transactions may be unable to file immediately due to credit netting - * rules. - */ const C_RETURNINVOICE = 5; - - /** - * Represents a proposed movement of inventory from one jurisdiction to another. - * - * This document type is used when physical goods are shipped from one jurisdiction to another, and it - * may cause updates in the tax liability for various jurisdictions. - * - * For an inventory transfer invoice, the `companyCode` of the transaction refers to the owner of the inventory - * that will be moved from one location to another. - * - * This is a temporary document type and is not saved in tax history. - */ const C_INVENTORYTRANSFERORDER = 6; - - /** - * Represents a movement of inventory from one jurisdiction to another that has been finalized. - * - * This document type is used when physical goods are shipped from one jurisdiction to another, and it - * may cause updates in the tax liability for various jurisdictions. - * - * For an inventory transfer invoice, the `companyCode` of the transaction refers to the owner of the inventory - * that will be moved from one location to another. - * - * This is a permanent document and is recorded in AvaTax. - */ const C_INVENTORYTRANSFERINVOICE = 7; - - /** - * Represents a VAT "Reverse Charge" mechanism transaction as defined in the European Union. - * - * A Reverse Charge transaction moves the responsibility for VAT reporting from the seller to the buyer, and - * is intended to allow simplification of commerce and reduce the reporting requirements for sellers that deliver - * goods and services into the single market. - * - * This is a temporary document type and is not saved in tax history. - */ const C_REVERSECHARGEORDER = 8; - - /** - * Represents a VAT "Reverse Charge" mechanism transaction as defined in the European Union. - * - * A Reverse Charge transaction moves the responsibility for VAT reporting from the seller to the buyer, and - * is intended to allow simplification of commerce and reduce the reporting requirements for sellers that deliver - * goods and services into the single market. - * - * This is a permanent document and is recorded in AvaTax. - */ const C_REVERSECHARGEINVOICE = 9; - - /** - * Not a real document type. - * - * This value is used when querying for documents. You can specify the type `Any` in some cases to permit the - * system to find any document matching other criteria. - */ const C_ANY = -1; } /** - * Type of certificate preview to download + * */ class CertificatePreviewType { - - /** - * Download a full printable PDF - */ const C_PDF = 1; - - /** - * Download a single page of the certificate in JPG format - */ const C_JPEG = 2; } /** - * Filing Frequency types + * */ class FilingFrequencyId { - - /** - * File once per month - */ const C_MONTHLY = 1; - - /** - * File once per three months - */ const C_QUARTERLY = 2; - - /** - * File twice per year - */ const C_SEMIANNUALLY = 3; - - /** - * File once per year - */ const C_ANNUALLY = 4; - - /** - * File every other month - */ const C_BIMONTHLY = 5; - - /** - * File only when there are documents to report - */ const C_OCCASIONAL = 6; - - /** - * File for the first two months of each quarter, then do not file on the quarterly month. - */ const C_INVERSEQUARTERLY = 7; - - /** - * File every week - */ const C_WEEKLY = 8; } /** - * Filing Status + * */ class FilingStatusId { @@ -281,24 +112,12 @@ class FilingStatusId /** - * Type of file request + * */ class PointOfSaleFileType { - - /** - * File is in Javascript Object Notation format - */ const C_JSON = 0; - - /** - * File is in Comma Separated Values format - */ const C_CSV = 1; - - /** - * File is in Extended Markup Language format - */ const C_XML = 2; } @@ -316,239 +135,84 @@ class PointOfSalePartnerId /** - * Status of an Avalara account + * */ class AccountStatusId { - - /** - * This account is not currently active. - */ const C_INACTIVE = 0; - - /** - * This account is active and in use. - */ const C_ACTIVE = 1; - - /** - * This account is flagged as a test account and may be temporary. - */ const C_TEST = 2; - - /** - * The account is new and is currently in the onboarding process. - * - * An account is considered new until the account administrator has reviewed and accepted - * [Avalara's terms and conditions](https://www.avalara.com/us/en/legal/terms.html). - */ const C_NEW = 3; } /** - * Status of an Avalara account + * */ class AccountTypeId { - - /** - * Regular AvaTax account. - */ const C_REGULAR = 1; - - /** - * Firm account. - */ const C_FIRM = 2; - - /** - * Client account created by firm. - */ const C_FIRMCLIENT = 3; } /** - * Permission level of a user + * */ class SecurityRoleId { - - /** - * NoAccess - */ const C_NOACCESS = 0; - - /** - * SiteAdmin - */ const C_SITEADMIN = 1; - - /** - * AccountOperator - */ const C_ACCOUNTOPERATOR = 2; - - /** - * AccountAdmin - */ const C_ACCOUNTADMIN = 3; - - /** - * AccountUser - */ const C_ACCOUNTUSER = 4; - - /** - * SystemAdmin - */ const C_SYSTEMADMIN = 5; - - /** - * Registrar - */ const C_REGISTRAR = 6; - - /** - * CSPTester - */ const C_CSPTESTER = 7; - - /** - * CSPAdmin - */ const C_CSPADMIN = 8; - - /** - * SystemOperator - */ const C_SYSTEMOPERATOR = 9; - - /** - * TechnicalSupportUser - */ const C_TECHNICALSUPPORTUSER = 10; - - /** - * TechnicalSupportAdmin - */ const C_TECHNICALSUPPORTADMIN = 11; - - /** - * TreasuryUser - */ const C_TREASURYUSER = 12; - - /** - * TreasuryAdmin - */ const C_TREASURYADMIN = 13; - - /** - * ComplianceUser - */ const C_COMPLIANCEUSER = 14; - - /** - * ComplianceAdmin - */ const C_COMPLIANCEADMIN = 15; - - /** - * ProStoresOperator - */ const C_PROSTORESOPERATOR = 16; - - /** - * CompanyUser - */ const C_COMPANYUSER = 17; - - /** - * CompanyAdmin - */ const C_COMPANYADMIN = 18; - - /** - * ComplianceTempUser - */ const C_COMPLIANCETEMPUSER = 19; - - /** - * ComplianceRootUser - */ const C_COMPLIANCEROOTUSER = 20; - - /** - * ComplianceOperator - */ const C_COMPLIANCEOPERATOR = 21; - - /** - * SSTAdmin - */ const C_SSTADMIN = 22; - - /** - * FirmUser - */ const C_FIRMUSER = 23; - - /** - * FirmAdmin - */ const C_FIRMADMIN = 24; } /** - * PasswordStatusId + * */ class PasswordStatusId { - - /** - * UserCannotChange - */ const C_USERCANNOTCHANGE = 0; - - /** - * UserCanChange - */ const C_USERCANCHANGE = 1; - - /** - * UserMustChange - */ const C_USERMUSTCHANGE = 2; } /** - * Represents a error code message + * */ class ErrorCodeId { - - /** - * Server has a configuration or setup problem - */ const C_SERVERCONFIGURATION = 1; - - /** - * User doesn't have rights to this account or company - */ const C_ACCOUNTINVALIDEXCEPTION = 2; const C_COMPANYINVALIDEXCEPTION = 3; - - /** - * Use this error message when the user is trying to fetch a single object and the object either does not exist or cannot be seen by the current user. - */ const C_ENTITYNOTFOUNDERROR = 4; const C_VALUEREQUIREDERROR = 5; const C_RANGEERROR = 6; @@ -688,11 +352,6 @@ class ErrorCodeId const C_INVALIDENTRY = 197; const C_TRANSACTIONALREADYCANCELLED = 198; const C_QUERYPARAMETEROUTOFRANGE = 199; - - /** - * Batch errors - * New batch error codes continue at 2501 - */ const C_BATCHSALESAUDITMUSTBEZIPPEDERROR = 200; const C_BATCHZIPMUSTCONTAINONEFILEERROR = 201; const C_BATCHINVALIDFILETYPEERROR = 202; @@ -702,22 +361,10 @@ class ErrorCodeId const C_BATCHMUSTCONTAINONEFILE = 206; const C_MISSINGBATCHFILECONTENT = 207; const C_BATCHCANNOTBEDELETEDWHILEPROCESSING = 208; - - /** - * BizTech error - */ const C_INTERNALSERVERERROR = 209; - - /** - * Point Of Sale API exceptions - */ const C_POINTOFSALEFILESIZE = 250; const C_POINTOFSALESETUP = 251; const C_INVALIDINPUTDATE = 252; - - /** - * Errors in Soap V1 Passthrough / GetTax calls - */ const C_GETTAXERROR = 300; const C_ADDRESSCONFLICTEXCEPTION = 301; const C_DOCUMENTCODECONFLICT = 303; @@ -732,31 +379,11 @@ class ErrorCodeId const C_INVALIDDOCUMENTTYPESTOFETCH = 315; const C_TIMEOUTREQUESTED = 316; const C_INVALIDPOSTALCODE = 317; - - /** - * Subscription error codes - */ const C_INVALIDSUBSCRIPTIONDESCRIPTION = 318; const C_INVALIDSUBSCRIPTIONTYPEID = 319; - - /** - * Represents a malformed document fetch command - */ const C_CANNOTCHANGEFILINGSTATUS = 401; - - /** - * Represents a FEIN in incorrect format. - */ const C_FEINFORMATERROR = 402; - - /** - * Represents a SQL server timeout error / deadlock error - */ const C_SERVERUNREACHABLE = 500; - - /** - * Partner API error codes - */ const C_SUBSCRIPTIONREQUIRED = 600; const C_ACCOUNTEXISTS = 601; const C_INVITATIONONLY = 602; @@ -767,10 +394,6 @@ class ErrorCodeId const C_OFFERCODEALREADYAPPLIED = 610; const C_ACCOUNTALREADYEXISTS = 611; const C_LICENSEKEYNAMEALREADYEXISTSFORACCOUNT = 612; - - /** - * Refund API error codes - */ const C_REFUNDTYPEANDPERCENTAGEMISMATCH = 701; const C_INVALIDDOCUMENTTYPEFORREFUND = 702; const C_REFUNDTYPEANDLINEMISMATCH = 703; @@ -780,25 +403,13 @@ class ErrorCodeId const C_LINENOOUTOFRANGE = 707; const C_REFUNDPERCENTAGEOUTOFRANGE = 708; const C_REFUNDPERCENTAGEMISSING = 709; - - /** - * Free API error codes - */ const C_MUSTUSECREATETRANSACTION = 800; const C_MUSTACCEPTTERMSANDCONDITIONS = 801; - - /** - * Filing Calendar Error Codes - */ const C_FILINGCALENDARCANNOTBEDELETED = 900; const C_INVALIDEFFECTIVEDATE = 901; const C_NONOUTLETFORM = 902; const C_OVERLAPPINGFILINGCALENDAR = 903; const C_FILINGCALENDARCANNOTBEEDITED = 904; - - /** - * Create or update transaction error codes - */ const C_CANNOTMODIFYLOCKEDTRANSACTION = 1100; const C_LINEALREADYEXISTS = 1101; const C_LINEDOESNOTEXIST = 1102; @@ -806,10 +417,6 @@ class ErrorCodeId const C_LINEDETAILSDOESNOTEXIST = 1104; const C_CANNOTCREATETRANSACTIONWITHDELETEDDATASOURCE = 1105; const C_SHIPTOREGIONREQUIREDWITHDATASOURCE = 1106; - - /** - * Exempt cert error codes - */ const C_INVALIDBUSINESSTYPE = 1200; const C_CANNOTMODIFYEXEMPTCERT = 1201; const C_CERTIFICATESERROR = 1203; @@ -831,10 +438,6 @@ class ErrorCodeId const C_BILLTOCUSTOMEREXPECTED = 1221; const C_SHIPTOCUSTOMEREXPECTED = 1222; const C_ECMSSSTCERTSREQUIRED = 1223; - - /** - * Multi document error codes - */ const C_TRANSACTIONNOTCANCELLED = 1300; const C_TOOMANYTRANSACTIONS = 1301; const C_ONLYTAXDATEOVERRIDEISALLOWED = 1302; @@ -847,21 +450,9 @@ class ErrorCodeId const C_MULTIDOCUMENTPARTIALLYLOCKED = 1312; const C_TRANSACTIONISCOMMITTED = 1313; const C_INVALIDDOCUMENTSTATUS = 1314; - - /** - * Communications Tax error codes - */ const C_COMMSCONFIGCLIENTIDMISSING = 1400; const C_COMMSCONFIGCLIENTIDBADVALUE = 1401; - - /** - * Account Activate error codes - */ const C_ACCOUNTINNEWSTATUSEXCEPTION = 1404; - - /** - * Worksheet Exception - */ const C_WORKSHEETEXCEPTION = 1405; const C_INVALIDACCOUNTOVERRIDE = 1406; const C_ACCOUNTOVERRIDENOTAUTHORIZED = 1407; @@ -869,30 +460,14 @@ class ErrorCodeId const C_USERNAMEREQUIRED = 1409; const C_INVALIDAUDITMESSAGE = 1410; const C_FIELDNOTORDERABLEERROR = 1411; - - /** - * Nexus validation error codes - */ const C_CANNOTDELETEPARENTBEFORECHILDNEXUS = 1500; const C_NEXUSCHILDDATEMISMATCH = 1501; - - /** - * Remote validation Error - */ const C_REMOTEVALIDATIONERROR = 1502; const C_CANNOTMODIFYSSTNEXUS = 1503; const C_INVALIDLOCALNEXUSTYPEID = 1504; - - /** - * Advanced rule errors - */ const C_ADVANCEDRULEREQUESTRULEERROR = 1602; const C_ADVANCEDRULERESPONSERULEERROR = 1603; const C_ADVANCEDRULEERROR = 1605; - - /** - * Miscellaneous - */ const C_TAXRULEREQUIRESNEXUS = 1701; const C_UPCCODENOTUNIQUE = 1702; const C_TAXCODEASSOCIATEDWITHITEMCODENOTFOUND = 1704; @@ -909,44 +484,20 @@ class ErrorCodeId const C_UPDATELOCATIONREMITTANCECHECKEXISTINGENDDATEERROR = 1721; const C_ERRORCOUNTLIMITEXCEEDEDERROR = 1722; const C_RATELIMITEXCEEDEDERROR = 1723; - - /** - * SendSales API errors - */ const C_UNSUPPORTEDFILEFORMAT = 1800; const C_UNSUPPORTEDOUTPUTFILETYPE = 1801; - - /** - * TaxProfile API errors - */ const C_TAXPROFILENOTPROVIDED = 1900; const C_INVALIDTAXPROFILE = 1901; const C_COMPANYTAXPROFILEENTRYREQUIRED = 1902; const C_ERRORREADINGTAXPROFILEENTRY = 1903; - - /** - * AuditAccount API errors - */ const C_TRACEDATANOTAVAILABLE = 2000; - - /** - * Item and Nexus parameter errors - */ const C_INVALIDPARAMETERUNITMEASUREMENTTYPE = 2100; const C_PARAMETERUNITREQUIRED = 2101; const C_INVALIDPARAMETERVALUEDATATYPE = 2102; const C_INVALIDPARAMETERATTRIBUTETYPE = 2103; const C_SUBSCRIPTIONREQUIREDFORPARAMETER = 2104; - - /** - * Accounting Firm errors - */ const C_INVALIDACCOUNTTYPE = 2105; const C_INVALIDFIRMSUBSCRIPTIONS = 2106; - - /** - * Certify Company Errors - */ const C_GENERICTAXCODEFORITEM = 2200; const C_CANNOTCERTIFYCOMPANY = 2201; const C_NOVOIDEDDOCUMENTS = 2202; @@ -967,24 +518,11 @@ class ErrorCodeId const C_ALLUSCOUNTRYCODES = 2217; const C_NODOCUMENTSTOTEST = 2218; const C_NOSHIPPINGCHARGE = 2219; - - /** - * Company Controller Related Errors - */ const C_FAILEDTOUPDATECOMPANYLOCATION = 2314; const C_COMPANYLOCATIONDATERANGEOVERLAP = 2315; - - /** - * Generic validation errors - */ const C_FIELDLENGTHERROR = 2400; const C_INPUTCONTAINSBLACKLISTEDCHARACTERS = 2401; const C_CANNOTCREATENESTEDOBJECTS = 2402; - - /** - * Batch errors - * For other batch errors, see: 200 - 208 above - */ const C_BATCHTRANSACTIONTYPEERROR = 2501; const C_BATCHTRANSACTIONLINELIMITEXCEEDED = 2502; const C_BATCHCOMPANYIDANDCOMPANYCODEMISMATCH = 2503; @@ -996,491 +534,181 @@ class ErrorCodeId /** - * Severity of message + * */ class SeverityLevel { - - /** - * Operation succeeded - */ const C_SUCCESS = 0; - - /** - * Warnings occured, operation succeeded - */ const C_WARNING = 1; - - /** - * Errors occured, operation failed - */ const C_ERROR = 2; - - /** - * Unexpected exceptions occurred, operation failed - */ const C_EXCEPTION = 3; } /** - * The address resolution quality of an address validation result + * */ class ResolutionQuality { - - /** - * Location was not geocoded - */ const C_NOTCODED = 0; - - /** - * Location was already geocoded on the request - */ const C_EXTERNAL = 1; - - /** - * Avalara-defined country centroid - */ const C_COUNTRYCENTROID = 2; - - /** - * Avalara-defined state / province centroid - */ const C_REGIONCENTROID = 3; - - /** - * Geocoded at a level more coarse than a PostalCentroid1 - */ const C_PARTIALCENTROID = 4; - - /** - * Largest postal code (zip5 in US, left three in CA, etc - */ const C_POSTALCENTROIDGOOD = 5; - - /** - * Better postal code (zip7 in US) - */ const C_POSTALCENTROIDBETTER = 6; - - /** - * Best postal code (zip9 in US, complete postal code elsewhere) - */ const C_POSTALCENTROIDBEST = 7; - - /** - * Nearest intersection - */ const C_INTERSECTION = 8; - - /** - * Interpolated to rooftop - */ const C_INTERPOLATED = 9; - - /** - * Assumed to be rooftop level, non-interpolated - */ const C_ROOFTOP = 10; - - /** - * Pulled from a static list of geocodes for specific jurisdictions - */ const C_CONSTANT = 11; } /** - * Jurisdiction Type + * */ class JurisdictionType { - - /** - * Country - */ const C_COUNTRY = 0; - - /** - * State - */ const C_STATE = 1; - - /** - * County - */ const C_COUNTY = 2; - - /** - * City - */ const C_CITY = 3; - - /** - * Special Tax Jurisdiction - */ const C_SPECIAL = 4; } /** - * Choice of rounding level for a transaction + * */ class RoundingLevelId { - - /** - * Round tax on each line separately - */ const C_LINE = 0; - - /** - * Round tax at the document level - */ const C_DOCUMENT = 1; } /** - * TaxDependencyLevelId + * */ class TaxDependencyLevelId { - - /** - * Document - */ const C_DOCUMENT = 0; - - /** - * State - */ const C_STATE = 1; - - /** - * TaxRegion - */ const C_TAXREGION = 2; - - /** - * Address - */ const C_ADDRESS = 3; } /** - * Indicates whether this address refers to a person or an business + * */ class AddressTypeId { - - /** - * A business location, for example a store, warehouse, or office. - */ const C_LOCATION = 1; - - /** - * A person's address who performs sales tasks for the company remotely from an office. - */ const C_SALESPERSON = 2; - - /** - * This location is a marketplace vendor that handles transactions on behalf of the company. - * When you select `Marketplace` as the address type for a location, you must then choose either - * `SellerRemitsTax` or `MarketplaceRemitsTax` to indicate which business entity is responsible - * for collecting and remitting tax for this location. - */ const C_MARKETPLACE = 3; } /** - * The type of address represented by this object + * */ class AddressCategoryId { - - /** - * Address refers to a storefront location - */ const C_STOREFRONT = 1; - - /** - * Address refers to a main office of this company - */ const C_MAINOFFICE = 2; - - /** - * Address refers to a warehouse or other non-public location - */ const C_WAREHOUSE = 3; - - /** - * Address refers to a location for a single salesperson - */ const C_SALESPERSON = 4; - - /** - * Address is a type not reflected in the other lists - */ const C_OTHER = 5; - - /** - * The marketplace vendor does not collect and remit tax for transactions tied to this - * location. Use this option if you are using a marketplace vendor to handle your transactions - * and your company is responsible for collecting and remitting all taxes for transactions tied - * to this location. - */ const C_SELLERREMITSTAX = 6; - - /** - * The marketplace vendor collects and remits tax on your behalf for all transactions tied - * to this location. Use this option if your marketplace vendor already pays sales and use - * taxes on your behalf. When this option is selected, all transactions tied to this location - * will be treated as already filed, and will be listed on each sales tax return as amounts - * already paid. - */ const C_MARKETPLACEREMITSTAX = 7; - - /** - * Address refers to the mailing address of your company which is not a physical location. - */ const C_NONPHYSICAL = 8; } /** - * Types of jurisdiction referenced in a transaction + * */ class JurisTypeId { - - /** - * State - */ const C_STA = 1; - - /** - * County - */ const C_CTY = 2; - - /** - * City - */ const C_CIT = 3; - - /** - * Special - */ const C_STJ = 4; - - /** - * Country - */ const C_CNT = 5; } /** - * Describes the different types of statuses which describe an entity (company). + * */ class NexusTypeId { - - /** - * Indicates no nexus - */ const C_NONE = 0; - - /** - * Indicates the entity is voluntarily collecting tax (default) - */ const C_SALESORSELLERSUSETAX = 1; - - /** - * Indicates the entity is required to collect tax in the state - */ const C_SALESTAX = 2; - - /** - * Indicates the entity is registered as a Volunteer in an SST state. - * Only your SST administrator may set this option. - */ const C_SSTVOLUNTEER = 3; - - /** - * Indicates the entity is registered as a Non-Volunteer in an SST state. - * Only your SST administrator may set this option. - */ const C_SSTNONVOLUNTEER = 4; } /** - * Sourcing + * */ class Sourcing { - - /** - * Mixed sourcing, for states that do both origin and destination calculation - */ const C_MIXED = 42; - - /** - * Destination - */ const C_DESTINATION = 68; - - /** - * Origin - */ const C_ORIGIN = 79; } /** - * Describes nexus type id + * */ class LocalNexusTypeId { - - /** - * Only the specific nexus objects declared for this company are declared. - */ const C_SELECTED = 0; - - /** - * Customer declares nexus in all state administered taxing authorities. - * - * This value only takes effect if you set `hasLocalNexus` = true. - */ const C_STATEADMINISTERED = 1; - - /** - * Customer declares nexus in all local taxing authorities. - * - * This value only takes effect if you set `hasLocalNexus` = true. - */ const C_ALL = 2; } /** - * This data type is only used when an object must "Match" tax types. By specifying options here, - * you can indicate which tax types will match for the purposes of this object. - * For example, if you specify BothSalesAndUseTax, this value matches with both sales and seller's use tax. + * */ class MatchingTaxType { - - /** - * Match medical excise type - */ const C_E = 5; - - /** - * Match Lodging tax type - */ const C_LODGING = 6; - - /** - * Match bottle tax type - */ const C_BOTTLE = 7; - - /** - * Match RentToOwn tax type - */ const C_RENTTOOWN = 8; - - /** - * Match all tax types - */ const C_ALL = 65; - - /** - * Match both Sales and Use Tax only - */ const C_BOTHSALESANDUSETAX = 66; - - /** - * Match Consumer Use Tax only - */ const C_CONSUMERUSETAX = 67; - - /** - * Match both Consumer Use and Seller's Use Tax types - */ const C_CONSUMERSUSEANDSELLERSUSETAX = 68; - - /** - * Match both Consumer Use and Sales Tax types - */ const C_CONSUMERUSEANDSALESTAX = 69; - - /** - * Match Fee tax types only - */ const C_FEE = 70; - - /** - * Match VAT Input Tax only - */ const C_VATINPUTTAX = 73; - - /** - * LightBulbs tax type - */ const C_LIGHTBULBS = 76; - - /** - * Match VAT Nonrecoverable Input Tax only - */ const C_VATNONRECOVERABLEINPUTTAX = 78; - - /** - * Match VAT Output Tax only - */ const C_VATOUTPUTTAX = 79; - - /** - * Match Rental tax types only - */ const C_RENTAL = 82; - - /** - * Match Sales Tax only - */ const C_SALESTAX = 83; - - /** - * Match Seller's Use Tax only - */ const C_USETAX = 85; - - /** - * EWaste tax type - */ const C_EWASTE = 87; - - /** - * Batteries tax type - */ const C_BATTERIES = 90; } @@ -1502,6 +730,7 @@ class RateType const C_SUPERREDUCED = 81; const C_REDUCEDR = 82; const C_STANDARD = 83; + const C_LEASING = 85; const C_SERVICES = 88; const C_ZERO = 90; @@ -1509,301 +738,127 @@ class RateType /** - * Specifies the type of custom tax rule you have created. + * */ class TaxRuleTypeId { - - /** - * Reserved for Avalara internal usage. - */ const C_RATERULE = 0; - - /** - * Specifies a rule that changes the rate of tax for a specified set of criteria. - * - * This rule can apply to one specific type of product (identified by `TaxCode`) or all products (identified by a null `TaxCode`). - */ const C_RATEOVERRIDERULE = 1; - - /** - * Specifies a rule that changes the tax base of a specific product. - * - * This rule can apply to one specific type of product (identified by `TaxCode`) or all products (identified by a null `TaxCode`). - */ const C_BASERULE = 2; - - /** - * Indicates that a particular product is exempt from tax due to an exempt usage reason. - * - * Amounts exempted by this rule are stored in the `exemptAmount` field on the transaction. - */ const C_EXEMPTENTITYRULE = 3; - - /** - * Specifies a rule that changes whether a product is taxable or not. - * - * This rule must be applied to a specific type of product. If you attempt to create a product taxability rule while - * leaving the `TaxCode` and `TaxCodeId` fields empty, you will get an error. - * - * A `value` field of `1` means that this tax code is taxable; `0` means it is nontaxable. - * - * Amounts that are considered not taxable according to this rule are stored in the `nonTaxableAmount` - * column in a transaction. - * - * This type of rule can also determine the rate type for a product or to apply a cap or threshold. - */ const C_PRODUCTTAXABILITYRULE = 4; - - /** - * Reserved for Avalara internal usage. - */ const C_NEXUSRULE = 5; } /** - * Exempt Cert type + * */ class ExemptCertTypeId { - - /** - * Blanked certificate - */ const C_BLANKET = 0; - - /** - * Single use - */ const C_SINGLEUSE = 1; } /** - * Status for this exempt certificate + * */ class ExemptCertStatusId { - - /** - * Inactive certificate - */ const C_INACTIVE = 0; - - /** - * Active certificate - */ const C_ACTIVE = 1; - - /** - * Expired certificate - */ const C_EXPIRED = 2; - - /** - * Revoked certificate - */ const C_REVOKED = 3; } /** - * Exempt certificate review status + * */ class ExemptCertReviewStatusId { - - /** - * Review pending - */ const C_PENDING = 0; - - /** - * Certificate was accepted - */ const C_ACCEPTED = 1; - - /** - * Certificate was rejected - */ const C_REJECTED = 2; } /** - * A list of possible AvaFile Form Types. + * */ class FormTypeId { - - /** - * Denotes the form type is Sales and Use Tax - */ const C_SALESANDUSE = 0; - - /** - * Denotes the form type is Sales Tax only - */ const C_SALES = 1; - - /** - * Denotes the form type is Sellers Use Tax only - */ const C_SELLERSUSE = 2; - - /** - * Denotes the form type is Lodging Tax only - */ const C_LODGING = 3; - - /** - * Denotes the form type is Sales and Lodging Tax - */ const C_SALESANDLODGING = 4; - - /** - * Denotes the form type is Consumer Use Tax only - */ const C_CONSUMERUSE = 5; - - /** - * Denotes the form type is Resort and Rental Tax - */ const C_RESORTANDRENTAL = 6; - - /** - * Denotes the form type is Tourist and Rental Tax - */ const C_TOURISTANDRENTAL = 7; - - /** - * Denotes the form type is Prepayment - */ const C_PREPAYMENT = 8; - - /** - * Denotes the form type is Prepayment Allowance - */ const C_PREPAYMENTALLOWED = 9; } /** - * A list of possible AvaFile filing option types. + * */ class FilingOptionTypeId { - - /** - * Denotes the tax return is being filed on paper. - */ const C_PAPER = 0; - - /** - * Denotes the form can be efiled optionally. - */ const C_OPTIONALEFILE = 1; - - /** - * Denotes the form is being filed via efile. - */ const C_MANDATORYEFILE = 2; } /** - * A list of possible Due Date Types + * */ class DueDateTypeId { - - /** - * Denotes form is due on the due day - */ const C_BYDAY = 0; - - /** - * Denotes form is due by last day of the month - */ const C_BYLASTDAY = 1; - - /** - * Denotes form is due by second to last day of the month - */ const C_BYSECONDLASTDAY = 2; } /** - * Indicates the rounding behavior of a form + * */ class RoundingTypeId { - - /** - * There is no rounding on the return - */ const C_NONE = 0; - - /** - * Round to the nearest whole number - */ const C_NEAREST = 1; - - /** - * Always round up - */ const C_UP = 2; - - /** - * Always round down - */ const C_DOWN = 3; } /** - * Indicates the behavior of a tax form for a company with multiple places of business. - * - * Some tax authorities require that a separate form must be filed for each place of business. + * */ class OutletTypeId { - - /** - * File a single return per cycle for your entire business. - */ const C_NONE = 0; - - /** - * You may file separate forms for each outlet; contact the tax authority for more details about location based reporting requirements. - */ const C_SCHEDULE = 1; - - /** - * You may file separate forms for each outlet; contact the tax authority for more details about location based reporting requirements. - */ const C_DUPLICATE = 2; - - /** - * File a single return, but you must have a line item for each place of business. - */ const C_CONSOLIDATED = 3; } /** - * The type of data contained in this batch + * */ class BatchType { @@ -1817,11 +872,6 @@ class BatchType const C_SALESAUDITEXPORT = 7; const C_SSTPTESTDECKIMPORT = 8; const C_TAXRULEIMPORT = 9; - - /** - * This batch type represents tax transaction data being uploaded to AvaTax. Each line in the batch represents a single transaction - * or a line in a multi-line transaction. For reference, see [Batched Transactions in REST v2](http://developer.avalara.com/blog/2016/10/24/batch-transaction-upload-in-rest-v2) - */ const C_TRANSACTIONIMPORT = 10; const C_UPCBULKIMPORT = 11; const C_UPCVALIDATIONIMPORT = 12; @@ -1830,299 +880,113 @@ class BatchType /** - * The status of a batch file + * */ class BatchStatus { - - /** - * Batch file has been received and is in the queue to be processed. - */ const C_WAITING = 0; - - /** - * Batch file experienced system errors and cannot be processed. - */ const C_SYSTEMERRORS = 1; - - /** - * Batch file is cancelled - */ const C_CANCELLED = 2; - - /** - * Batch file has been completely processed. - */ const C_COMPLETED = 3; - - /** - * Batch file is currently being created. - */ const C_CREATING = 4; - - /** - * Batch file has been deleted. - */ const C_DELETED = 5; - - /** - * Batch file was processed with some errors. - */ const C_ERRORS = 6; - - /** - * Batch processing was paused. - */ const C_PAUSED = 7; - - /** - * Batch is currently being processed. - */ const C_PROCESSING = 8; } /** - * Service modes for tax calculation when using an AvaLocal server. + * */ class ServiceMode { - - /** - * Automatically use local or remote (default) - */ const C_AUTOMATIC = 0; - - /** - * Local server only - */ const C_LOCAL = 1; - - /** - * Remote server only - */ const C_REMOTE = 2; } /** - * Indicates the level of detail requested from a tax API call + * */ class TaxDebugLevel { - - /** - * User requests the normal level of debug information when creating a tax transaction - */ const C_NORMAL = 0; - - /** - * User requests additional diagnostic information when creating a tax transaction - */ const C_DIAGNOSTIC = 1; } /** - * Indicates the type of adjustment that was performed on a transaction + * */ class AdjustmentReason { - - /** - * The transaction has not been adjusted - */ const C_NOTADJUSTED = 0; - - /** - * A sourcing issue existed which caused the transaction to be adjusted - */ const C_SOURCINGISSUE = 1; - - /** - * Transaction was adjusted to reconcile it with a general ledger - */ const C_RECONCILEDWITHGENERALLEDGER = 2; - - /** - * Transaction was adjusted after an exemption certificate was applied - */ const C_EXEMPTCERTAPPLIED = 3; - - /** - * Transaction was adjusted when the price of an item changed - */ const C_PRICEADJUSTED = 4; - - /** - * Transaction was adjusted due to a product return - */ const C_PRODUCTRETURNED = 5; - - /** - * Transaction was adjusted due to a product exchange - */ const C_PRODUCTEXCHANGED = 6; - - /** - * Transaction was adjusted due to bad or uncollectable debt - */ const C_BADDEBT = 7; - - /** - * Transaction was adjusted for another reason not specified - */ const C_OTHER = 8; - - /** - * Offline - */ const C_OFFLINE = 9; } /** - * Reason code for voiding or cancelling a transaction + * */ class VoidReasonCode { - - /** - * Unspecified reason - */ const C_UNSPECIFIED = 0; - - /** - * Post operation failed - Document status will be changed to unposted - */ const C_POSTFAILED = 1; - - /** - * Document deleted - If committed, document status will be changed to Cancelled. If not committed, document will be - * deleted. - */ const C_DOCDELETED = 2; - - /** - * Document has been voided and DocStatus will be set to Cancelled - */ const C_DOCVOIDED = 3; - - /** - * AdjustTax operation has been cancelled. Adjustment will be reversed. - */ const C_ADJUSTMENTCANCELLED = 4; } /** - * Represents a type of tax override requested by the customer. - * - * AvaTax allows customers to override some behavior of the AvaTax engine. When you use a - * Tax Override, you can import tax that was previously calculated and charged to the customer exactly - * as it was charged. AvaTax will record the type of override used for each transaction. + * */ class TaxOverrideType { - - /** - * AvaTax calculated the tax for this transaction, and no override occurred. - */ const C_NONE = 0; - - /** - * AvaTax calculated tax for this transaction, but the final tax amount on the transaction was - * determined outside of AvaTax. To see the tax amounts determined by AvaTax, look at the - * `taxCalculated` field. To see the tax amounts determined by the customer's outside tax engine, - * look at the `taxAmount` field. - * - * This behavior can also occur when a customer requests a refund. For refunds calculated using the - * `RefundTransaction` API, AvaTax will ensure that the exact tax charged to the customer is refunded - * to the customer using a tax amount override. - */ const C_TAXAMOUNT = 1; - - /** - * Entity exemption was ignored (e.g. item was consumed) - */ const C_EXEMPTION = 2; - - /** - * AvaTax was instructed to calculate this transaction using the tax rules that were in effect - * on a different day than the transaction occurred. - * - * This behavior typically occurs during refunds. If the customer attempts to return a product - * without a receipt that shows the exact tax amount paid, AvaTax can calculate tax on the date - * when they believed that the product was purchased. - */ const C_TAXDATE = 3; - - /** - * To support Consumer Use Tax - */ const C_ACCRUEDTAXAMOUNT = 4; - - /** - * Derive the taxable amount from the tax amount - */ const C_DERIVETAXABLE = 5; - - /** - * This is for the documents that are calculated outside of AvaTax and passed in to AvaTax - * specifically for reporting/Returns purposes - */ const C_OUTOFHARBOR = 6; } /** - * The way of delivering request + * */ class CertificateRequestDeliveryMethod { - - /** - * The invitation will be sent via email to the recipient's email address. - */ const C_EMAIL = 1; - - /** - * The invitation will be sent via facsimile to the recipient's facsimile phone number. - * - * Facsimile transmission make take time to process and deliver via phone lines. - */ const C_FAX = 2; - - /** - * The request will be processed and turned into a web link (URL) which the user can click on to visit the CertExpress site and immediately - * begin entering data about their certificates. - */ const C_DOWNLOAD = 3; } /** - * Indicates the status of a CertExpress invitation link. + * */ class CertExpressInvitationStatus { - - /** - * The CertExpress website is currently building a landing page for the customer. Please - * wait about 10 seconds and fetch this request again to see when it will be ready. - */ const C_INPROGRESS = 0; - - /** - * Indicates that the CertExpress invitation has been completed and is ready to use. - */ const C_READY = 1; } @@ -2133,17 +997,7 @@ class CertExpressInvitationStatus */ class CertCaptureProvisionStatus { - - /** - * Account and company are provisioned - */ const C_PROVISIONED = 0; - - /** - * Provision job is being queued - * This could also be an indication that some companies under an account has been provisioned, while others - * under the same account has not. - */ const C_INPROGRESS = 1; const C_NOTPROVISIONED = 2; @@ -2151,259 +1005,90 @@ class CertCaptureProvisionStatus /** - * Indicates whether Avalara Managed Returns has begun filing for this company. + * */ class CompanyFilingStatus { - - /** - * This company is not a reporting entity and cannot file taxes. To change this behavior, you must mark - * the company as a reporting entity. - */ const C_NOREPORTING = 0; - - /** - * This company is a reporting entity, but Avalara is not currently filing tax returns for this company. - */ const C_NOTYETFILING = 1; - - /** - * The customer has requested that Avalara Managed Returns begin filing for this company, however filing has - * not yet started. Avalara's compliance team is reviewing this request and will update the company to - * first filing status when complete. - */ const C_FILINGREQUESTED = 2; - - /** - * Avalara has begun filing tax returns for this company. Normally, this status will change to `Active` after - * one month of successful filing of tax returns. - */ const C_FIRSTFILING = 3; - - /** - * Avalara currently files tax returns for this company. - */ const C_ACTIVE = 4; - - /** - * This company has not been configured for compliance - */ const C_NOTCONFIGUREDFORCOMPLIANCE = 5; } /** - * The `DocumentStatus` value indicates the state of the document as it moves through the - * AvaTax document workflow. More information about the AvaTax document workflow is available - * in the [AvaTax Developer Guide](https://developer.avalara.com/avatax/dev-guide/transactions/should-i-commit). + * */ class DocumentStatus { - - /** - * Temporary document not saved (SalesOrder, PurchaseOrder). - * - * This document has not been recorded to AvaTax - */ const C_TEMPORARY = 0; - - /** - * Saved document (SalesInvoice or PurchaseInvoice) ready to be posted. - * - * This status indicates that the transaction has been saved to AvaTax, but is not available - * to be reported on a tax filing, and has not yet been verified by a business process that - * posts transactions. - * - * To mark this transaction as `Posted`, please call `VerifyTransaction` or `SettleTransaction`. - * - * To mark this transaction as `Committed`, please call `CommitTransaction` or `SettleTransaction`. - * - * To adjust or void this transaction, call `AdjustTransaction`, `CreateOrAdjustTransaction`, or - * `VoidTransaction`. - */ const C_SAVED = 1; - - /** - * A posted document (not committed). - * - * This status indicates that the transaction has been saved to AvaTax, and has been verified - * by a business process that posts transactions, but is not ready to report on a tax filing. - * - * To mark this transaction as `Committed`, please call `CommitTransaction` or `SettleTransaction`. - * - * To adjust or void this transaction, call `AdjustTransaction`, `CreateOrAdjustTransaction`, or - * `VoidTransaction`. - */ const C_POSTED = 2; - - /** - * A posted document that has been committed. - * - * This status indicates that the transaction has been saved to AvaTax and can be reported - * on a tax filing. - * - * If you use Avalara's Managed Returns Service, these transactions will be captured and reported - * on a tax return. When this occurs, the transaction's `locked` flag will be set to true. Once - * the transaction is locked, no further changes may occur. - * - * As long as the transaction has not been locked, you may adjust or void this transaction using - * `AdjustTransaction`, `CreateOrAdjustTransaction`, or `VoidTransaction`. - */ const C_COMMITTED = 3; - - /** - * A document that has been cancelled. - * - * This status indicates that the transaction has been cancelled or voided. Cancelled and Voided - * are synonyms. - * - * When a transaction has been cancelled, it is considered to no longer exist. You are free to create - * a new transaction with the same code. - */ const C_CANCELLED = 4; - - /** - * An older version of a document that has been adjusted. - * - * When you call `AdjustTransaction`, AvaTax preserves a record of the old document as well as a record - * of the new document. The old document is changed to the status `Adjusted`, and the new document - * is created in the status you requested. - */ const C_ADJUSTED = 5; - - /** - * DEPRECATED - A document which is queued for later processing. - */ const C_QUEUED = 6; - - /** - * Indicates that this document requires approval from a governmental agency before it can be finalized. - * - * Some governments require active verification of transactions before they can be finalized. When AvaTax - * detects that a transaction must be verified with a governmental agency, this transaction will be flagged - * as `PendingApproval` until the government has certified the transaction. - */ const C_PENDINGAPPROVAL = 7; - - /** - * DEPRECATED - Represents "a document in any status" when searching. Please search using the - * [Filtering in REST](/avatax/filtering-in-rest/) documentation. - */ const C_ANY = -1; } /** - * Jurisdiction boundary precision level found for address. This depends on the accuracy of the address - * as well as the precision level of the state provided jurisdiction boundaries. + * */ class BoundaryLevel { - - /** - * Street address precision - */ const C_ADDRESS = 0; - - /** - * 9-digit zip precision - */ const C_ZIP9 = 1; - - /** - * 5-digit zip precision - */ const C_ZIP5 = 2; } /** - * Type of verification task + * */ class ScraperType { - - /** - * Indicates that is is a login type - */ const C_LOGIN = 1; - - /** - * Indicates that it is a Customer DOR Data type - */ const C_CUSTOMERDORDATA = 2; } /** - * Status when deleting an error transaction + * */ class AvataxDeleteErrorTransactionStatus { - - /** - * Successful delete - */ const C_SUCCESS = 0; - - /** - * Failed delete - */ const C_FAILURE = 1; } /** - * A list of possible AvaFile filing types. + * */ class FilingTypeId { - - /** - * Denotes the tax return is being filed on paper. - */ const C_PAPERRETURN = 0; - - /** - * Denotes the tax return is being filed via electronic means; excludes SST electronic filing. - */ const C_ELECTRONICRETURN = 1; - - /** - * Denotes the tax return is an SST filing. - */ const C_SER = 2; - - /** - * Denotes a return is paid via EFT and filed on paper without payment. - */ const C_EFTPAPER = 3; - - /** - * Denotes a return is paid via phone and filed on paper without payment. - */ const C_PHONEPAPER = 4; - - /** - * Denotes a return is prepared but delivered to the customer for filing and payment. - */ const C_SIGNATUREREADY = 5; - - /** - * Denotes a return which is filed online but paid by check. - */ const C_EFILECHECK = 6; } /** - * A list of bulk account validation statuses for filing calendars. + * */ class BulkAccountValidationStatus { @@ -2415,97 +1100,41 @@ class BulkAccountValidationStatus /** - * Filing Request Status types + * */ class FilingRequestStatus { - - /** - * Customer is building a request for a new filing calendar - */ const C_NEW = 1; - - /** - * Customer’s information validated before submitting to go live. All required information as per state and form selection is entered. - */ const C_VALIDATED = 2; - - /** - * Customer submitted a request for a new filing calendar - */ const C_PENDING = 3; - - /** - * Filing calender is active - */ const C_ACTIVE = 4; - - /** - * Customer requested to deactivate filing calendar - */ const C_PENDINGSTOP = 5; - - /** - * Filing calendar is inactive - */ const C_INACTIVE = 6; - - /** - * This indicates that there is a new change request. - */ const C_CHANGEREQUEST = 7; - - /** - * This indicates that the change request was approved. - */ const C_REQUESTAPPROVED = 8; - - /** - * This indicates that compliance rejected the request. - */ const C_REQUESTDENIED = 9; } /** - * Accrual types + * */ class AccrualType { - - /** - * Filing indicates that this tax return should be filed with its tax authority by its due date. For example, if you file annually, you will have eleven months of Accrual returns and one Filing return. - */ const C_FILING = 1; - - /** - * An Accrual filing indicates taxes that are accrued, intended to be filed on a future tax return. For example, if you file annually, you will have eleven months of Accrual returns and one Filing return. - */ const C_ACCRUAL = 2; } /** - * Filing worksheet Type + * */ class WorksheetTypeId { - - /** - * The original filing for a period - */ const C_ORIGINAL = 0; - - /** - * Represents an amended filing for a period - */ const C_AMENDED = 1; - - /** - * Represents a test filing - */ const C_TEST = 2; } @@ -2537,383 +1166,170 @@ class PaymentAccountTypeId /** - * Indicates the type of payments + * */ class PaymentType { - - /** - * The payment is for the current payment - */ const C_CURRENTPERIOD = 0; - - /** - * The payment is a prepayment - */ const C_PREPAYMENT = 1; - - /** - * The payment is a prior payment - */ const C_PRIORPAYMENT = 2; - - /** - * The payment is a prior CSP fee - */ const C_PRIORCSPFEE = 3; } /** - * Account Linkage status + * */ class FirmClientLinkageStatus { - - /** - * Requested - */ const C_REQUESTED = 1; - - /** - * Approved - */ const C_APPROVED = 2; - - /** - * Rejected - */ const C_REJECTED = 3; - - /** - * Revoked - */ const C_REVOKED = 4; } /** - * Refund types + * */ class RefundType { - - /** - * Refund the whole transaction. - */ const C_FULL = 0; - - /** - * Refund only specific lines from the original a transaction. - */ const C_PARTIAL = 1; - - /** - * Only refund the tax part of the transaction. - */ const C_TAXONLY = 2; - - /** - * Refund a percentage of the value of this transaction. - */ const C_PERCENTAGE = 3; } /** - * Indicates what level of auditing information is available for a transaction + * */ class ApiCallStatus { - - /** - * If the original api call is availabe on S3 - */ const C_ORIGINALAPICALLAVAILABLE = 0; - - /** - * if the original api call is not available, reconstructed api call should always be available - */ const C_RECONSTRUCTEDAPICALLAVAILABLE = 1; - - /** - * Any other api call status - */ const C_ANY = -1; } /** - * Filing Frequency types + * */ class NoticeCustomerType { - - /** - * AvaTax Returns - */ const C_AVATAXRETURNS = 1; - - /** - * Stand Alone - */ const C_STANDALONE = 2; - - /** - * Strategic - */ const C_STRATEGIC = 3; - - /** - * SST - */ const C_SST = 4; - - /** - * TrustFile - */ const C_TRUSTFILE = 5; - - /** - * PWC - */ const C_PWC = 6; - - /** - * Hudson Group - */ const C_HUDSONGROUP = 7; } /** - * A list of possible AvaFile filing types for tax notices. + * */ class TaxNoticeFilingTypeId { - - /** - * Denotes the tax return is being filed via electronic means; excludes SST electronic filing. - */ const C_ELECTRONICRETURN = 1; - - /** - * Denotes the tax return is being filed on paper. - */ const C_PAPERRETURN = 2; - - /** - * Denotes the tax return that was not filed. - */ const C_RETURNNOTFILED = 3; - - /** - * Denotes a return is paid via EFT and filed on paper without payment. - */ const C_EFTPAPER = 4; - - /** - * Denotes the tax return is an SST filing. - */ const C_SER = 5; - - /** - * Denotes the tax return is a Trudsfile-EDI filing. - */ const C_TRUSTFILEEDI = 6; - - /** - * Denotes the tax return is an uploaded file. - */ const C_UPLOADFILE = 7; - - /** - * Denotes the tax return was manually filed via paper - */ const C_PAPERMANUAL = 8; - - /** - * Denotes a cert capture return - */ const C_CERTCAPTURE = 9; - - /** - * Denotes a signature ready return - */ const C_SIGNATUREREADY = 10; } /** - * Filing Frequency types + * */ class FundingOption { - - /** - * Pull - */ const C_PULL = 1; - - /** - * Wire - */ const C_WIRE = 2; } /** - * Filing Frequency types + * */ class NoticePriorityId { - - /** - * Immediate Attention Required - */ const C_IMMEDIATEATTENTIONREQUIRED = 1; - - /** - * High - */ const C_HIGH = 2; - - /** - * Normal - */ const C_NORMAL = 3; - - /** - * Low - */ const C_LOW = 4; } /** - * Comment Types + * */ class CommentType { - - /** - * Internal comments are those comments only intended to be for compliance users - */ const C_INTERNAL = 1; - - /** - * Customer comments are those comments that both compliance and the customer can read - */ const C_CUSTOMER = 2; - - /** - * A comment that has a POA Attachment on it - */ const C_POAATTACHMENT = 3; - - /** - * Used when creating Notice Comments in Returns Console - */ const C_NOTICEVOUCHER = 4; } /** - * Severity level of a notification. + * */ class NotificationSeverityLevel { - - /** - * Low priority notification, Default. - */ const C_NEUTRAL = 0; - - /** - * Medium priority notification. - */ const C_ADVISORY = 1; - - /** - * High priority notification. - */ const C_BLOCKING = 2; - - /** - * A completed notification - */ const C_COMPLETE = -1; } /** - * Different types of formats allowed for exporting a report + * */ class ReportFormat { - - /** - * The Comma Separated Values file format - */ const C_CSV = 0; } /** - * The date filter type for report - * "RD" for Reporting Date, "DD" for Document Date, "TD" for Tax Date, "PD" for Payment Date + * */ class ReportDateFilter { - - /** - * The date when the transaction is posted - */ const C_DOCUMENTDATE = 68; - - /** - * The date when the transaction is paid for - */ const C_PAYMENTDATE = 80; - - /** - * The date when the transaction is added to report - */ const C_REPORTINGDATE = 82; - - /** - * The date when the transaction is being taxed - */ const C_TAXDATE = 84; } /** - * The output DocumentType for a report + * */ class ReportDocType { - - /** - * Output all ConsumerUse tax transactions in the report - */ const C_CONSUMERUSE = 67; - - /** - * Output all Sales tax transactions in the report - */ const C_SALES = 83; } @@ -2936,78 +1352,34 @@ class SendSalesOutputFileFormat */ class SendSalesFileType { - - /** - * File is in Comma Separated Values format - */ const C_CSV = 0; - - /** - * File is in Javascript Object Notation format - */ const C_JSON = 1; } /** - * Indicates the level of companies that can be accessed + * */ class CompanyAccessLevel { - - /** - * No permission to access companies. - */ const C_NONE = 0; - - /** - * Permission to access a single company and its children. - */ const C_SINGLECOMPANY = 1; - - /** - * Permission to access all companies in a single account. - */ const C_SINGLEACCOUNT = 2; - - /** - * Permission to access all companies in all accounts. Reserved for system administration tasks. - */ const C_ALLCOMPANIES = 3; - - /** - * Permission to access all companies in all accounts managed by a firm account. - */ const C_FIRMMANAGEDACCOUNTS = 4; } /** - * Represents the type of authentication provided to the API call + * */ class AuthenticationTypeId { - - /** - * This API call was not authenticated. - */ const C_NONE = 0; - - /** - * This API call was authenticated by your username/password. - */ const C_USERNAMEPASSWORD = 1; - - /** - * This API call was authenticated by your Avalara Account ID and private license key. - */ const C_ACCOUNTIDLICENSEKEY = 2; - - /** - * This API call was authenticated by OpenID Bearer Token. - */ const C_OPENIDBEARERTOKEN = 3; } diff --git a/src/Methods.php b/src/Methods.php index 0986a38..4157b38 100644 --- a/src/Methods.php +++ b/src/Methods.php @@ -482,6 +482,27 @@ public function deleteLookupFile($accountId, $id) return $this->restCall($path, 'DELETE', $guzzleParams); } + /** + * Get audit records by account id and date range. + * + * + * + * + * @param int $accountId The ID of the account + * @param string $fromDate Date + * @param string $toDate Date + * @return AdvancedRuleLookupFileModel + */ + public function getAuditRecords($accountId, $fromDate, $toDate) + { + $path = "/api/v2/advancedrules/audits/accounts/{$accountId}/from/{$fromDate}/to/{$toDate}"; + $guzzleParams = [ + 'query' => [], + 'body' => null + ]; + return $this->restCall($path, 'GET', $guzzleParams); + } + /** * Get the lookup files for a company * @@ -2911,7 +2932,7 @@ public function updateCustomer($companyId, $customerCode, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param int $companyId The id of the company you which to create the datasources @@ -2936,7 +2957,7 @@ public function createDataSources($companyId, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param int $companyId The id of the company the datasource belongs to. @@ -2961,7 +2982,7 @@ public function deleteDataSource($companyId, $id) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param int $companyId @@ -2986,7 +3007,7 @@ public function getDataSourceById($companyId, $id) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param int $companyId The id of the company you wish to retrieve the datasources. @@ -3017,7 +3038,7 @@ public function listDataSources($companyId, $filter=null, $top=null, $skip=null, * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @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 @@ -3044,7 +3065,7 @@ public function queryDataSources($filter=null, $top=null, $skip=null, $orderBy=n * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param int $companyId The id of the company the datasource belongs to. @@ -4166,13 +4187,14 @@ public function listPreferredPrograms($filter=null, $top=null, $skip=null, $orde * @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 FetchResult */ - public function listProductClassificationSystems($filter=null, $top=null, $skip=null, $orderBy=null) + public function listProductClassificationSystems($filter=null, $top=null, $skip=null, $orderBy=null, $countryCode) { $path = "/api/v2/definitions/productclassificationsystems"; $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], 'body' => null ]; return $this->restCall($path, 'GET', $guzzleParams); @@ -4192,13 +4214,14 @@ public function listProductClassificationSystems($filter=null, $top=null, $skip= * @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 FetchResult */ - public function listProductClassificationSystemsByCompany($companyCode, $filter=null, $top=null, $skip=null, $orderBy=null) + public function listProductClassificationSystemsByCompany($companyCode, $filter=null, $top=null, $skip=null, $orderBy=null, $countryCode) { $path = "/api/v2/definitions/productclassificationsystems/bycompany/{$companyCode}"; $guzzleParams = [ - 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], + 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], 'body' => null ]; return $this->restCall($path, 'GET', $guzzleParams); @@ -6249,6 +6272,8 @@ public function validateLocation($companyId, $id) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6295,6 +6320,8 @@ public function adjustMultiDocumentTransaction($code, $type, $include=null, $mod * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6333,6 +6360,8 @@ public function auditMultiDocumentTransaction($code, $type) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6394,6 +6423,8 @@ public function commitMultiDocumentTransaction($model) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6436,6 +6467,8 @@ public function createMultiDocumentTransaction($include=null, $model) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6488,6 +6521,8 @@ public function getMultiDocumentTransactionByCodeAndType($code, $type, $include= * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6537,6 +6572,8 @@ public function getMultiDocumentTransactionById($id, $include=null) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6606,6 +6643,8 @@ public function listMultiDocumentTransactions($filter=null, $include=null, $top= * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6644,6 +6683,8 @@ public function refundMultiDocumentTransaction($code, $type, $include=null, $mod * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -6682,6 +6723,8 @@ public function verifyMultiDocumentTransaction($model) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -8509,7 +8552,7 @@ public function updateTaxRule($companyId, $id, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $include Specifies objects to include in the response after transaction is created @@ -8555,12 +8598,14 @@ public function addLines($include=null, $model) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The company code of the company that recorded this transaction @@ -8603,12 +8648,14 @@ public function adjustTransaction($companyCode, $transactionCode, $documentType, * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The code identifying the company that owns this transaction @@ -8648,12 +8695,14 @@ public function auditTransaction($companyCode, $transactionCode) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The code identifying the company that owns this transaction @@ -8730,12 +8779,14 @@ public function bulkLockTransaction($model) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The company code of the company that recorded this transaction @@ -8783,6 +8834,8 @@ public function changeTransactionCode($companyCode, $transactionCode, $documentT * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -8952,7 +9005,7 @@ public function createTransaction($include=null, $model) * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $include Specifies objects to include in the response after transaction is created @@ -8995,6 +9048,8 @@ public function deleteLines($include=null, $model) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -9028,6 +9083,8 @@ public function getTransactionByCode($companyCode, $transactionCode, $documentTy * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -9122,6 +9179,8 @@ public function getTransactionById($id, $include=null) * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -9178,6 +9237,8 @@ public function listTransactionsByCompany($companyCode, $dataSourceId, $include= * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -9242,12 +9303,14 @@ public function lockTransaction($companyCode, $transactionCode, $documentType, $ * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The code of the company that made the original sale @@ -9296,6 +9359,8 @@ public function refundTransaction($companyCode, $transactionCode, $include=null, * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies @@ -9342,12 +9407,14 @@ public function settleTransaction($companyCode, $transactionCode, $documentType, * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The company code of the company that recorded this transaction @@ -9385,12 +9452,14 @@ public function uncommitTransaction($companyCode, $transactionCode, $documentTyp * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The company code of the company that recorded this transaction @@ -9435,12 +9504,14 @@ public function unvoidTransaction($companyCode, $transactionCode, $documentType, * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies * * * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin. - * * This API depends on the following active services
*Required* (all): AvaTaxPro. + * * This API depends on the following active services
*Required* (all): AvaTaxPro, BasicReturns. * * * @param string $companyCode The company code of the company that recorded this transaction @@ -9488,6 +9559,8 @@ public function verifyTransaction($companyCode, $transactionCode, $documentType, * * Replace '/' with '\_-ava2f-\_' For example: document/Code becomes document_-ava2f-_Code * * Replace '+' with '\_-ava2b-\_' For example: document+Code becomes document_-ava2b-_Code * * Replace '?' with '\_-ava3f-\_' For example: document?Code becomes document_-ava3f-_Code + * * Replace '%' with '\_-ava25-\_' For example: document%Code becomes document_-ava25-_Code + * * Replace '#' with '\_-ava23-\_' For example: document#Code becomes document_-ava23-_Code * * Replace ' ' with '%20' For example: document Code becomes document%20Code * * ### Security Policies diff --git a/src/Models.php b/src/Models.php index f4c5ee0..a47f924 100644 --- a/src/Models.php +++ b/src/Models.php @@ -3035,6 +3035,16 @@ class AdvancedRuleLookupFileModel */ public $version; + /** + * @var string Lookup file CreatedOn + */ + public $createdDate; + + /** + * @var string Lookup file ModifiedOn + */ + public $modifiedDate; + } /** @@ -3690,6 +3700,16 @@ class AddressesModel */ public $pointOfOrderAcceptance; + /** + * @var AddressLocationInfo The address where the goods are located or where services are rendered.This address type is valid only for VAT transactions. + */ + public $goodsPlaceOrServiceRendered; + + /** + * @var AddressLocationInfo The address of the buyer importing a good from another country.This address type is valid only for VAT transactions. + */ + public $import; + } /** @@ -8827,7 +8847,7 @@ class CompanyDistanceThresholdModel /** * */ -class CappedFetchResult +class CappedFetchResult[ErrorTransactionOutputModel] { /** @@ -8997,6 +9017,39 @@ class DeleteErrorTransactionResponseModel } +/** + * + */ +class CappedFetchResult[ErrorCodeOutputModel] +{ + + /** + * @var boolean + */ + public $_isRecordsetCountCapped; + + /** + * @var int + */ + public $_recordsetCount; + + /** + * @var ErrorCodeOutputModel[] + */ + public $value; + + /** + * @var string + */ + public $_nextLink; + + /** + * @var string + */ + public $pageKey; + +} + /** * Model that has the matching count for an errorcode */ @@ -11114,6 +11167,26 @@ class FilingsTaxSummaryModel */ public $taxAccrualAmount; + /** + * @var float reportableSalesAmount + */ + public $reportableSalesAmount; + + /** + * @var float reportableNonTaxableAmount + */ + public $reportableNonTaxableAmount; + + /** + * @var float reportableTaxableAmount + */ + public $reportableTaxableAmount; + + /** + * @var float reportableTaxAmount + */ + public $reportableTaxAmount; + } /** @@ -13781,6 +13854,11 @@ class PingResultModel */ public $authenticatedAccountId; + /** + * @var int The ID number of the currently authenticated user's company, if any. + */ + public $authenticatedCompanyId; + /** * @var string The connected Salesforce account. */ From 4b08e397200dd7ba10dd0062408d9cd1c0058dd1 Mon Sep 17 00:00:00 2001 From: contygm Date: Fri, 17 Jul 2020 21:10:20 +0000 Subject: [PATCH 2/3] 20-7-update update --- src/Constants.php | 292 ++--- src/Methods.php | 912 +++++---------- src/Models.php | 2849 +-------------------------------------------- 3 files changed, 382 insertions(+), 3671 deletions(-) diff --git a/src/Constants.php b/src/Constants.php index 05ce4ff..186a373 100644 --- a/src/Constants.php +++ b/src/Constants.php @@ -30,19 +30,16 @@ class TransactionAddressType * */ class TextCase -{ - const C_UPPER = 0; +{ const C_UPPER = 0; const C_MIXED = 1; } - /** * */ class DocumentType -{ - const C_SALESORDER = 0; +{ const C_SALESORDER = 0; const C_SALESINVOICE = 1; const C_PURCHASEORDER = 2; const C_PURCHASEINVOICE = 3; @@ -56,24 +53,20 @@ class DocumentType } - /** * */ class CertificatePreviewType -{ - const C_PDF = 1; +{ const C_PDF = 1; const C_JPEG = 2; } - /** * */ class FilingFrequencyId -{ - const C_MONTHLY = 1; +{ const C_MONTHLY = 1; const C_QUARTERLY = 2; const C_SEMIANNUALLY = 3; const C_ANNUALLY = 4; @@ -84,13 +77,11 @@ class FilingFrequencyId } - /** * */ class FilingStatusId -{ - const C_PENDINGAPPROVAL = 0; +{ const C_PENDINGAPPROVAL = 0; const C_DIRTY = 1; const C_APPROVEDTOFILE = 2; const C_PENDINGFILING = 3; @@ -110,61 +101,51 @@ class FilingStatusId } - /** * */ class PointOfSaleFileType -{ - const C_JSON = 0; +{ const C_JSON = 0; const C_CSV = 1; const C_XML = 2; } - /** * */ class PointOfSalePartnerId -{ - const C_DMA = 1; +{ const C_DMA = 1; const C_AX7 = 2; } - /** * */ class AccountStatusId -{ - const C_INACTIVE = 0; +{ const C_INACTIVE = 0; const C_ACTIVE = 1; const C_TEST = 2; const C_NEW = 3; } - /** * */ class AccountTypeId -{ - const C_REGULAR = 1; +{ const C_REGULAR = 1; const C_FIRM = 2; const C_FIRMCLIENT = 3; } - /** * */ class SecurityRoleId -{ - const C_NOACCESS = 0; +{ const C_NOACCESS = 0; const C_SITEADMIN = 1; const C_ACCOUNTOPERATOR = 2; const C_ACCOUNTADMIN = 3; @@ -192,25 +173,21 @@ class SecurityRoleId } - /** * */ class PasswordStatusId -{ - const C_USERCANNOTCHANGE = 0; +{ const C_USERCANNOTCHANGE = 0; const C_USERCANCHANGE = 1; const C_USERMUSTCHANGE = 2; } - /** * */ class ErrorCodeId -{ - const C_SERVERCONFIGURATION = 1; +{ const C_SERVERCONFIGURATION = 1; const C_ACCOUNTINVALIDEXCEPTION = 2; const C_COMPANYINVALIDEXCEPTION = 3; const C_ENTITYNOTFOUNDERROR = 4; @@ -532,26 +509,22 @@ class ErrorCodeId } - /** * */ class SeverityLevel -{ - const C_SUCCESS = 0; +{ const C_SUCCESS = 0; const C_WARNING = 1; const C_ERROR = 2; const C_EXCEPTION = 3; } - /** * */ class ResolutionQuality -{ - const C_NOTCODED = 0; +{ const C_NOTCODED = 0; const C_EXTERNAL = 1; const C_COUNTRYCENTROID = 2; const C_REGIONCENTROID = 3; @@ -566,13 +539,11 @@ class ResolutionQuality } - /** * */ class JurisdictionType -{ - const C_COUNTRY = 0; +{ const C_COUNTRY = 0; const C_STATE = 1; const C_COUNTY = 2; const C_CITY = 3; @@ -580,49 +551,41 @@ class JurisdictionType } - /** * */ class RoundingLevelId -{ - const C_LINE = 0; +{ const C_LINE = 0; const C_DOCUMENT = 1; } - /** * */ class TaxDependencyLevelId -{ - const C_DOCUMENT = 0; +{ const C_DOCUMENT = 0; const C_STATE = 1; const C_TAXREGION = 2; const C_ADDRESS = 3; } - /** * */ class AddressTypeId -{ - const C_LOCATION = 1; +{ const C_LOCATION = 1; const C_SALESPERSON = 2; const C_MARKETPLACE = 3; } - /** * */ class AddressCategoryId -{ - const C_STOREFRONT = 1; +{ const C_STOREFRONT = 1; const C_MAINOFFICE = 2; const C_WAREHOUSE = 3; const C_SALESPERSON = 4; @@ -633,13 +596,11 @@ class AddressCategoryId } - /** * */ class JurisTypeId -{ - const C_STA = 1; +{ const C_STA = 1; const C_CTY = 2; const C_CIT = 3; const C_STJ = 4; @@ -647,13 +608,11 @@ class JurisTypeId } - /** * */ class NexusTypeId -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_SALESORSELLERSUSETAX = 1; const C_SALESTAX = 2; const C_SSTVOLUNTEER = 3; @@ -661,37 +620,31 @@ class NexusTypeId } - /** * */ class Sourcing -{ - const C_MIXED = 42; +{ const C_MIXED = 42; const C_DESTINATION = 68; const C_ORIGIN = 79; } - /** * */ class LocalNexusTypeId -{ - const C_SELECTED = 0; +{ const C_SELECTED = 0; const C_STATEADMINISTERED = 1; const C_ALL = 2; } - /** * */ class MatchingTaxType -{ - const C_E = 5; +{ const C_E = 5; const C_LODGING = 6; const C_BOTTLE = 7; const C_RENTTOOWN = 8; @@ -713,13 +666,11 @@ class MatchingTaxType } - /** * */ class RateType -{ - const C_REDUCEDA = 65; +{ const C_REDUCEDA = 65; const C_REDUCEDB = 66; const C_FOOD = 70; const C_GENERAL = 71; @@ -736,13 +687,11 @@ class RateType } - /** * */ class TaxRuleTypeId -{ - const C_RATERULE = 0; +{ const C_RATERULE = 0; const C_RATEOVERRIDERULE = 1; const C_BASERULE = 2; const C_EXEMPTENTITYRULE = 3; @@ -751,49 +700,41 @@ class TaxRuleTypeId } - /** * */ class ExemptCertTypeId -{ - const C_BLANKET = 0; +{ const C_BLANKET = 0; const C_SINGLEUSE = 1; } - /** * */ class ExemptCertStatusId -{ - const C_INACTIVE = 0; +{ const C_INACTIVE = 0; const C_ACTIVE = 1; const C_EXPIRED = 2; const C_REVOKED = 3; } - /** * */ class ExemptCertReviewStatusId -{ - const C_PENDING = 0; +{ const C_PENDING = 0; const C_ACCEPTED = 1; const C_REJECTED = 2; } - /** * */ class FormTypeId -{ - const C_SALESANDUSE = 0; +{ const C_SALESANDUSE = 0; const C_SALES = 1; const C_SELLERSUSE = 2; const C_LODGING = 3; @@ -806,63 +747,53 @@ class FormTypeId } - /** * */ class FilingOptionTypeId -{ - const C_PAPER = 0; +{ const C_PAPER = 0; const C_OPTIONALEFILE = 1; const C_MANDATORYEFILE = 2; } - /** * */ class DueDateTypeId -{ - const C_BYDAY = 0; +{ const C_BYDAY = 0; const C_BYLASTDAY = 1; const C_BYSECONDLASTDAY = 2; } - /** * */ class RoundingTypeId -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_NEAREST = 1; const C_UP = 2; const C_DOWN = 3; } - /** * */ class OutletTypeId -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_SCHEDULE = 1; const C_DUPLICATE = 2; const C_CONSOLIDATED = 3; } - /** * */ class BatchType -{ - const C_AVACERTUPDATE = 0; +{ const C_AVACERTUPDATE = 0; const C_AVACERTUPDATEALL = 1; const C_BATCHMAINTENANCE = 2; const C_COMPANYLOCATIONIMPORT = 3; @@ -878,13 +809,11 @@ class BatchType } - /** * */ class BatchStatus -{ - const C_WAITING = 0; +{ const C_WAITING = 0; const C_SYSTEMERRORS = 1; const C_CANCELLED = 2; const C_COMPLETED = 3; @@ -896,36 +825,30 @@ class BatchStatus } - /** * */ class ServiceMode -{ - const C_AUTOMATIC = 0; +{ const C_AUTOMATIC = 0; const C_LOCAL = 1; const C_REMOTE = 2; } - /** * */ class TaxDebugLevel -{ - const C_NORMAL = 0; +{ const C_NORMAL = 0; const C_DIAGNOSTIC = 1; } - /** * */ class AdjustmentReason -{ - const C_NOTADJUSTED = 0; +{ const C_NOTADJUSTED = 0; const C_SOURCINGISSUE = 1; const C_RECONCILEDWITHGENERALLEDGER = 2; const C_EXEMPTCERTAPPLIED = 3; @@ -938,13 +861,11 @@ class AdjustmentReason } - /** * */ class VoidReasonCode -{ - const C_UNSPECIFIED = 0; +{ const C_UNSPECIFIED = 0; const C_POSTFAILED = 1; const C_DOCDELETED = 2; const C_DOCVOIDED = 3; @@ -952,13 +873,11 @@ class VoidReasonCode } - /** * */ class TaxOverrideType -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_TAXAMOUNT = 1; const C_EXEMPTION = 2; const C_TAXDATE = 3; @@ -968,48 +887,40 @@ class TaxOverrideType } - /** * */ class CertificateRequestDeliveryMethod -{ - const C_EMAIL = 1; +{ const C_EMAIL = 1; const C_FAX = 2; const C_DOWNLOAD = 3; } - /** * */ class CertExpressInvitationStatus -{ - const C_INPROGRESS = 0; +{ const C_INPROGRESS = 0; const C_READY = 1; } - /** * */ class CertCaptureProvisionStatus -{ - const C_PROVISIONED = 0; +{ const C_PROVISIONED = 0; const C_INPROGRESS = 1; const C_NOTPROVISIONED = 2; } - /** * */ class CompanyFilingStatus -{ - const C_NOREPORTING = 0; +{ const C_NOREPORTING = 0; const C_NOTYETFILING = 1; const C_FILINGREQUESTED = 2; const C_FIRSTFILING = 3; @@ -1018,13 +929,11 @@ class CompanyFilingStatus } - /** * */ class DocumentStatus -{ - const C_TEMPORARY = 0; +{ const C_TEMPORARY = 0; const C_SAVED = 1; const C_POSTED = 2; const C_COMMITTED = 3; @@ -1036,47 +945,39 @@ class DocumentStatus } - /** * */ class BoundaryLevel -{ - const C_ADDRESS = 0; +{ const C_ADDRESS = 0; const C_ZIP9 = 1; const C_ZIP5 = 2; } - /** * */ class ScraperType -{ - const C_LOGIN = 1; +{ const C_LOGIN = 1; const C_CUSTOMERDORDATA = 2; } - /** * */ class AvataxDeleteErrorTransactionStatus -{ - const C_SUCCESS = 0; +{ const C_SUCCESS = 0; const C_FAILURE = 1; } - /** * */ class FilingTypeId -{ - const C_PAPERRETURN = 0; +{ const C_PAPERRETURN = 0; const C_ELECTRONICRETURN = 1; const C_SER = 2; const C_EFTPAPER = 3; @@ -1086,25 +987,21 @@ class FilingTypeId } - /** * */ class BulkAccountValidationStatus -{ - const C_NEW = 0; +{ const C_NEW = 0; const C_ADDED = 1; const C_FAILED = 2; } - /** * */ class FilingRequestStatus -{ - const C_NEW = 1; +{ const C_NEW = 1; const C_VALIDATED = 2; const C_PENDING = 3; const C_ACTIVE = 4; @@ -1116,112 +1013,94 @@ class FilingRequestStatus } - /** * */ class AccrualType -{ - const C_FILING = 1; +{ const C_FILING = 1; const C_ACCRUAL = 2; } - /** * */ class WorksheetTypeId -{ - const C_ORIGINAL = 0; +{ const C_ORIGINAL = 0; const C_AMENDED = 1; const C_TEST = 2; } - /** * */ class AdjustmentPeriodTypeId -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_CURRENTPERIOD = 1; const C_NEXTPERIOD = 2; } - /** * */ class PaymentAccountTypeId -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_ACCOUNTSRECEIVABLEACCOUNTSPAYABLE = 1; const C_ACCOUNTSRECEIVABLE = 2; const C_ACCOUNTSPAYABLE = 3; } - /** * */ class PaymentType -{ - const C_CURRENTPERIOD = 0; +{ const C_CURRENTPERIOD = 0; const C_PREPAYMENT = 1; const C_PRIORPAYMENT = 2; const C_PRIORCSPFEE = 3; } - /** * */ class FirmClientLinkageStatus -{ - const C_REQUESTED = 1; +{ const C_REQUESTED = 1; const C_APPROVED = 2; const C_REJECTED = 3; const C_REVOKED = 4; } - /** * */ class RefundType -{ - const C_FULL = 0; +{ const C_FULL = 0; const C_PARTIAL = 1; const C_TAXONLY = 2; const C_PERCENTAGE = 3; } - /** * */ class ApiCallStatus -{ - const C_ORIGINALAPICALLAVAILABLE = 0; +{ const C_ORIGINALAPICALLAVAILABLE = 0; const C_RECONSTRUCTEDAPICALLAVAILABLE = 1; const C_ANY = -1; } - /** * */ class NoticeCustomerType -{ - const C_AVATAXRETURNS = 1; +{ const C_AVATAXRETURNS = 1; const C_STANDALONE = 2; const C_STRATEGIC = 3; const C_SST = 4; @@ -1231,13 +1110,11 @@ class NoticeCustomerType } - /** * */ class TaxNoticeFilingTypeId -{ - const C_ELECTRONICRETURN = 1; +{ const C_ELECTRONICRETURN = 1; const C_PAPERRETURN = 2; const C_RETURNNOTFILED = 3; const C_EFTPAPER = 4; @@ -1250,120 +1127,100 @@ class TaxNoticeFilingTypeId } - /** * */ class FundingOption -{ - const C_PULL = 1; +{ const C_PULL = 1; const C_WIRE = 2; } - /** * */ class NoticePriorityId -{ - const C_IMMEDIATEATTENTIONREQUIRED = 1; +{ const C_IMMEDIATEATTENTIONREQUIRED = 1; const C_HIGH = 2; const C_NORMAL = 3; const C_LOW = 4; } - /** * */ class CommentType -{ - const C_INTERNAL = 1; +{ const C_INTERNAL = 1; const C_CUSTOMER = 2; const C_POAATTACHMENT = 3; const C_NOTICEVOUCHER = 4; } - /** * */ class NotificationSeverityLevel -{ - const C_NEUTRAL = 0; +{ const C_NEUTRAL = 0; const C_ADVISORY = 1; const C_BLOCKING = 2; const C_COMPLETE = -1; } - /** * */ class ReportFormat -{ - const C_CSV = 0; +{ const C_CSV = 0; } - /** * */ class ReportDateFilter -{ - const C_DOCUMENTDATE = 68; +{ const C_DOCUMENTDATE = 68; const C_PAYMENTDATE = 80; const C_REPORTINGDATE = 82; const C_TAXDATE = 84; } - /** * */ class ReportDocType -{ - const C_CONSUMERUSE = 67; +{ const C_CONSUMERUSE = 67; const C_SALES = 83; } - /** * */ class SendSalesOutputFileFormat -{ - const C_STANDARD = 1; +{ const C_STANDARD = 1; const C_DMA = 2; const C_DMA_NEW = 3; } - /** * */ class SendSalesFileType -{ - const C_CSV = 0; +{ const C_CSV = 0; const C_JSON = 1; } - /** * */ class CompanyAccessLevel -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_SINGLECOMPANY = 1; const C_SINGLEACCOUNT = 2; const C_ALLCOMPANIES = 3; @@ -1371,17 +1228,14 @@ class CompanyAccessLevel } - /** * */ class AuthenticationTypeId -{ - const C_NONE = 0; +{ const C_NONE = 0; const C_USERNAMEPASSWORD = 1; const C_ACCOUNTIDLICENSEKEY = 2; const C_OPENIDBEARERTOKEN = 3; } - ?> \ No newline at end of file diff --git a/src/Methods.php b/src/Methods.php index 4157b38..8aa5962 100644 --- a/src/Methods.php +++ b/src/Methods.php @@ -47,8 +47,7 @@ class AvaTaxClient extends AvaTaxClientBase * @param ResetLicenseKeyModel $model A request confirming that you wish to reset the license key of this account. * @return LicenseKeyModel */ - public function accountResetLicenseKey($id, $model) - { + public function accountResetLicenseKey($id, $model) { $path = "/api/v2/accounts/{$id}/resetlicensekey"; $guzzleParams = [ 'query' => [], @@ -80,8 +79,7 @@ public function accountResetLicenseKey($id, $model) * @param ActivateAccountModel $model The activation request * @return AccountModel */ - public function activateAccount($id, $model) - { + public function activateAccount($id, $model) { $path = "/api/v2/accounts/{$id}/activate"; $guzzleParams = [ 'query' => [], @@ -120,8 +118,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 FetchResult */ - public function auditAccount($id, $start, $end, $top=null, $skip=null) - { + 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], @@ -153,8 +150,7 @@ public function auditAccount($id, $start, $end, $top=null, $skip=null) * @param AccountLicenseKeyModel $model * @return LicenseKeyModel */ - public function createLicenseKey($id, $model) - { + public function createLicenseKey($id, $model) { $path = "/api/v2/accounts/{$id}/licensekey"; $guzzleParams = [ 'query' => [], @@ -181,8 +177,7 @@ public function createLicenseKey($id, $model) * @param string $licensekeyname The license key name you wish to update. * @return ErrorDetail[] */ - public function deleteLicenseKey($id, $licensekeyname) - { + public function deleteLicenseKey($id, $licensekeyname) { $path = "/api/v2/accounts/{$id}/licensekey/{$licensekeyname}"; $guzzleParams = [ 'query' => [], @@ -209,8 +204,7 @@ public function deleteLicenseKey($id, $licensekeyname) * @param string $include A comma separated list of special fetch options * @return AccountModel */ - public function getAccount($id, $include=null) - { + public function getAccount($id, $include=null) { $path = "/api/v2/accounts/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -243,8 +237,7 @@ public function getAccount($id, $include=null) * @param int $id * @return AccountConfigurationModel[] */ - public function getAccountConfiguration($id) - { + public function getAccountConfiguration($id) { $path = "/api/v2/accounts/{$id}/configuration"; $guzzleParams = [ 'query' => [], @@ -265,8 +258,7 @@ public function getAccountConfiguration($id) * @param string $licensekeyname The ID of the account to retrieve * @return AccountLicenseKeyModel */ - public function getLicenseKey($id, $licensekeyname) - { + public function getLicenseKey($id, $licensekeyname) { $path = "/api/v2/accounts/{$id}/licensekey/{$licensekeyname}"; $guzzleParams = [ 'query' => [], @@ -288,8 +280,7 @@ public function getLicenseKey($id, $licensekeyname) * @param int $id The ID of the account to retrieve * @return AccountLicenseKeyModel[] */ - public function getLicenseKeys($id) - { + public function getLicenseKeys($id) { $path = "/api/v2/accounts/{$id}/licensekeys"; $guzzleParams = [ 'query' => [], @@ -326,8 +317,7 @@ public function getLicenseKeys($id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryAccounts($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -361,8 +351,7 @@ public function queryAccounts($include=null, $filter=null, $top=null, $skip=null * @param AccountConfigurationModel[] $model * @return AccountConfigurationModel[] */ - public function setAccountConfiguration($id, $model) - { + public function setAccountConfiguration($id, $model) { $path = "/api/v2/accounts/{$id}/configuration"; $guzzleParams = [ 'query' => [], @@ -402,8 +391,7 @@ public function setAccountConfiguration($id, $model) * @param string $textCase selectable text case for address validation (See TextCase::* for a list of allowable values) * @return AddressResolutionModel */ - public function resolveAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $textCase) - { + 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], @@ -431,8 +419,7 @@ public function resolveAddress($line1, $line2, $line3, $city, $region, $postalCo * @param AddressValidationInfo $model The address to resolve * @return AddressResolutionModel */ - public function resolveAddressPost($model) - { + public function resolveAddressPost($model) { $path = "/api/v2/addresses/resolve"; $guzzleParams = [ 'query' => [], @@ -452,8 +439,7 @@ public function resolveAddressPost($model) * @param AdvancedRuleLookupFileModel $model The lookup file you wish to create * @return AdvancedRuleLookupFileModel */ - public function createCompanyLookupFile($accountId, $companyId, $model) - { + public function createCompanyLookupFile($accountId, $companyId, $model) { $path = "/api/v2/advancedrules/accounts/{$accountId}/companies/{$companyId}/lookupFiles"; $guzzleParams = [ 'query' => [], @@ -472,8 +458,7 @@ public function createCompanyLookupFile($accountId, $companyId, $model) * @param string $id The unique ID/GUID for the company lookup file to be deleted * @return ErrorDetail[] */ - public function deleteLookupFile($accountId, $id) - { + public function deleteLookupFile($accountId, $id) { $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; $guzzleParams = [ 'query' => [], @@ -493,8 +478,7 @@ public function deleteLookupFile($accountId, $id) * @param string $toDate Date * @return AdvancedRuleLookupFileModel */ - public function getAuditRecords($accountId, $fromDate, $toDate) - { + public function getAuditRecords($accountId, $fromDate, $toDate) { $path = "/api/v2/advancedrules/audits/accounts/{$accountId}/from/{$fromDate}/to/{$toDate}"; $guzzleParams = [ 'query' => [], @@ -513,8 +497,7 @@ public function getAuditRecords($accountId, $fromDate, $toDate) * @param int $companyId The ID of the company for which to retrieve lookup files * @return FetchResult */ - public function getCompanyLookupFiles($accountId, $companyId) - { + public function getCompanyLookupFiles($accountId, $companyId) { $path = "/api/v2/advancedrules/accounts/{$accountId}/companies/{$companyId}/lookupFiles"; $guzzleParams = [ 'query' => [], @@ -533,8 +516,7 @@ public function getCompanyLookupFiles($accountId, $companyId) * @param string $id The unique ID/GUID of the company lookup file to return * @return AdvancedRuleLookupFileModel */ - public function getLookupFile($accountId, $id) - { + public function getLookupFile($accountId, $id) { $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; $guzzleParams = [ 'query' => [], @@ -554,8 +536,7 @@ public function getLookupFile($accountId, $id) * @param AdvancedRuleLookupFileModel $model The new values to update the lookup file * @return AdvancedRuleLookupFileModel */ - public function updateLookupFile($accountId, $id, $model) - { + public function updateLookupFile($accountId, $id, $model) { $path = "/api/v2/advancedrules/accounts/{$accountId}/lookupFiles/{$id}"; $guzzleParams = [ 'query' => [], @@ -579,8 +560,7 @@ public function updateLookupFile($accountId, $id, $model) * @param AvaFileFormModel[] $model The AvaFileForm you wish to create. * @return AvaFileFormModel[] */ - public function createAvaFileForms($model) - { + public function createAvaFileForms($model) { $path = "/api/v2/avafileforms"; $guzzleParams = [ 'query' => [], @@ -603,8 +583,7 @@ public function createAvaFileForms($model) * @param int $id The ID of the AvaFileForm you wish to delete. * @return ErrorDetail[] */ - public function deleteAvaFileForm($id) - { + public function deleteAvaFileForm($id) { $path = "/api/v2/avafileforms/{$id}"; $guzzleParams = [ 'query' => [], @@ -627,8 +606,7 @@ public function deleteAvaFileForm($id) * @param int $id The primary key of this AvaFileForm * @return AvaFileFormModel */ - public function getAvaFileForm($id) - { + public function getAvaFileForm($id) { $path = "/api/v2/avafileforms/{$id}"; $guzzleParams = [ 'query' => [], @@ -655,8 +633,7 @@ public function getAvaFileForm($id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -681,8 +658,7 @@ public function queryAvaFileForms($filter=null, $top=null, $skip=null, $orderBy= * @param AvaFileFormModel $model The AvaFileForm model you wish to update. * @return AvaFileFormModel */ - public function updateAvaFileForm($id, $model) - { + public function updateAvaFileForm($id, $model) { $path = "/api/v2/avafileforms/{$id}"; $guzzleParams = [ 'query' => [], @@ -716,8 +692,7 @@ public function updateAvaFileForm($id, $model) * @param int $id The ID of the batch to cancel. * @return BatchModel */ - public function cancelBatch($companyId, $id) - { + public function cancelBatch($companyId, $id) { $path = "/api/v2/companies/{$companyId}/batches/{$id}/cancel"; $guzzleParams = [ 'query' => [], @@ -758,8 +733,7 @@ public function cancelBatch($companyId, $id) * @param BatchModel[] $model The batch you wish to create. * @return BatchModel[] */ - public function createBatches($companyId, $model) - { + public function createBatches($companyId, $model) { $path = "/api/v2/companies/{$companyId}/batches"; $guzzleParams = [ 'query' => [], @@ -798,8 +772,7 @@ public function createBatches($companyId, $model) * @param CreateTransactionBatchRequestModel $model The transaction batch you wish to create. * @return CreateTransactionBatchResponseModel */ - public function createTransactionBatch($companyId, $model) - { + public function createTransactionBatch($companyId, $model) { $path = "/api/v2/companies/{$companyId}/batches/transactions"; $guzzleParams = [ 'query' => [], @@ -831,8 +804,7 @@ public function createTransactionBatch($companyId, $model) * @param int $id The ID of the batch to delete. * @return ErrorDetail[] */ - public function deleteBatch($companyId, $id) - { + public function deleteBatch($companyId, $id) { $path = "/api/v2/companies/{$companyId}/batches/{$id}"; $guzzleParams = [ 'query' => [], @@ -856,8 +828,7 @@ public function deleteBatch($companyId, $id) * @param int $id The primary key of this batch file object * @return object */ - public function downloadBatch($companyId, $batchId, $id) - { + public function downloadBatch($companyId, $batchId, $id) { $path = "/api/v2/companies/{$companyId}/batches/{$batchId}/files/{$id}/attachment"; $guzzleParams = [ 'query' => [], @@ -894,8 +865,7 @@ public function downloadBatch($companyId, $batchId, $id) * @param int $id The primary key of this batch * @return BatchModel */ - public function getBatch($companyId, $id) - { + public function getBatch($companyId, $id) { $path = "/api/v2/companies/{$companyId}/batches/{$id}"; $guzzleParams = [ 'query' => [], @@ -942,8 +912,7 @@ public function getBatch($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listBatchesByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -986,8 +955,7 @@ public function listBatchesByCompany($companyId, $filter=null, $include=null, $t * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryBatches($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -1026,8 +994,7 @@ public function queryBatches($filter=null, $include=null, $top=null, $skip=null, * @param CreateCertExpressInvitationModel[] $model the requests to send out to customers * @return CertExpressInvitationStatusModel[] */ - public function createCertExpressInvitation($companyId, $customerCode, $model) - { + public function createCertExpressInvitation($companyId, $customerCode, $model) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certexpressinvites"; $guzzleParams = [ 'query' => [], @@ -1067,8 +1034,7 @@ public function createCertExpressInvitation($companyId, $customerCode, $model) * @param string $include OPTIONAL: A comma separated list of special fetch options. No options are defined at this time. * @return CertExpressInvitationModel */ - public function getCertExpressInvitation($companyId, $customerCode, $id, $include=null) - { + public function getCertExpressInvitation($companyId, $customerCode, $id, $include=null) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certexpressinvites/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -1110,8 +1076,7 @@ public function getCertExpressInvitation($companyId, $customerCode, $id, $includ * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCertExpressInvitations($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -1156,8 +1121,7 @@ public function listCertExpressInvitations($companyId, $include=null, $filter=nu * @param CertificateModel[] $model Certificates to be created * @return CertificateModel[] */ - public function createCertificates($companyId, $preValidatedExemptionReason, $model) - { + public function createCertificates($companyId, $preValidatedExemptionReason, $model) { $path = "/api/v2/companies/{$companyId}/certificates"; $guzzleParams = [ 'query' => ['$preValidatedExemptionReason' => $preValidatedExemptionReason], @@ -1193,8 +1157,7 @@ public function createCertificates($companyId, $preValidatedExemptionReason, $mo * @param int $id The unique ID number of this certificate * @return ErrorDetail[] */ - public function deleteCertificate($companyId, $id) - { + public function deleteCertificate($companyId, $id) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; $guzzleParams = [ 'query' => [], @@ -1233,8 +1196,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 object */ - public function downloadCertificateImage($companyId, $id, $page, $type) - { + public function downloadCertificateImage($companyId, $id, $page, $type) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attachment"; $guzzleParams = [ 'query' => ['$page' => $page, '$type' => $type], @@ -1275,8 +1237,7 @@ public function downloadCertificateImage($companyId, $id, $page, $type) * @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 CertificateModel */ - public function getCertificate($companyId, $id, $include=null) - { + public function getCertificate($companyId, $id, $include=null) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -1305,8 +1266,7 @@ public function getCertificate($companyId, $id, $include=null) * @param int $companyId The company ID to check * @return ProvisionStatusModel */ - public function getCertificateSetup($companyId) - { + public function getCertificateSetup($companyId) { $path = "/api/v2/companies/{$companyId}/certificates/setup"; $guzzleParams = [ 'query' => [], @@ -1344,8 +1304,7 @@ public function getCertificateSetup($companyId) * @param CertificateAttributeModel[] $model The list of attributes to link to this certificate. * @return FetchResult */ - public function linkAttributesToCertificate($companyId, $id, $model) - { + public function linkAttributesToCertificate($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes/link"; $guzzleParams = [ 'query' => [], @@ -1384,8 +1343,7 @@ public function linkAttributesToCertificate($companyId, $id, $model) * @param LinkCustomersModel $model The list of customers needed be added to the Certificate for exemption * @return FetchResult */ - public function linkCustomersToCertificate($companyId, $id, $model) - { + public function linkCustomersToCertificate($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers/link"; $guzzleParams = [ 'query' => [], @@ -1422,8 +1380,7 @@ public function linkCustomersToCertificate($companyId, $id, $model) * @param int $id The unique ID number of this certificate * @return FetchResult */ - public function listAttributesForCertificate($companyId, $id) - { + public function listAttributesForCertificate($companyId, $id) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes"; $guzzleParams = [ 'query' => [], @@ -1461,8 +1418,7 @@ public function listAttributesForCertificate($companyId, $id) * @param string $include OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers. * @return FetchResult */ - public function listCustomersForCertificate($companyId, $id, $include=null) - { + public function listCustomersForCertificate($companyId, $id, $include=null) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -1506,8 +1462,7 @@ public function listCustomersForCertificate($companyId, $id, $include=null) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryCertificates($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -1538,8 +1493,7 @@ public function queryCertificates($companyId, $include=null, $filter=null, $top= * @param int $companyId * @return ProvisionStatusModel */ - public function requestCertificateSetup($companyId) - { + public function requestCertificateSetup($companyId) { $path = "/api/v2/companies/{$companyId}/certificates/setup"; $guzzleParams = [ 'query' => [], @@ -1577,8 +1531,7 @@ public function requestCertificateSetup($companyId) * @param CertificateAttributeModel[] $model The list of attributes to unlink from this certificate. * @return FetchResult */ - public function unlinkAttributesFromCertificate($companyId, $id, $model) - { + public function unlinkAttributesFromCertificate($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attributes/unlink"; $guzzleParams = [ 'query' => [], @@ -1618,8 +1571,7 @@ public function unlinkAttributesFromCertificate($companyId, $id, $model) * @param LinkCustomersModel $model The list of customers to unlink from this certificate * @return FetchResult */ - public function unlinkCustomersFromCertificate($companyId, $id, $model) - { + public function unlinkCustomersFromCertificate($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/customers/unlink"; $guzzleParams = [ 'query' => [], @@ -1654,8 +1606,7 @@ public function unlinkCustomersFromCertificate($companyId, $id, $model) * @param CertificateModel $model The new certificate object that will replace the existing one * @return CertificateModel */ - public function updateCertificate($companyId, $id, $model) - { + public function updateCertificate($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}"; $guzzleParams = [ 'query' => [], @@ -1693,8 +1644,7 @@ public function updateCertificate($companyId, $id, $model) * @param object $file The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG. * @return string */ - public function uploadCertificateImage($companyId, $id, $file) - { + public function uploadCertificateImage($companyId, $id, $file) { $path = "/api/v2/companies/{$companyId}/certificates/{$id}/attachment"; $guzzleParams = [ 'query' => [], @@ -1738,8 +1688,7 @@ public function uploadCertificateImage($companyId, $id, $file) * @param int $id The ID of the company to check if its integration is certified. * @return string */ - public function certifyIntegration($id) - { + public function certifyIntegration($id) { $path = "/api/v2/companies/{$id}/certify"; $guzzleParams = [ 'query' => [], @@ -1774,8 +1723,7 @@ public function certifyIntegration($id) * @param FilingStatusChangeModel $model * @return string */ - public function changeFilingStatus($id, $model) - { + public function changeFilingStatus($id, $model) { $path = "/api/v2/companies/{$id}/filingstatus"; $guzzleParams = [ 'query' => [], @@ -1808,8 +1756,7 @@ public function changeFilingStatus($id, $model) * @param CompanyInitializationModel $model Information about the company you wish to create. * @return CompanyModel */ - public function companyInitialize($model) - { + public function companyInitialize($model) { $path = "/api/v2/companies/initialize"; $guzzleParams = [ 'query' => [], @@ -1835,8 +1782,7 @@ public function companyInitialize($model) * @param CompanyModel[] $model Either a single company object or an array of companies to create * @return CompanyModel[] */ - public function createCompanies($model) - { + public function createCompanies($model) { $path = "/api/v2/companies"; $guzzleParams = [ 'query' => [], @@ -1869,8 +1815,7 @@ public function createCompanies($model) * @param FundingInitiateModel $model The funding initialization request * @return FundingStatusModel */ - public function createFundingRequest($id, $model) - { + public function createFundingRequest($id, $model) { $path = "/api/v2/companies/{$id}/funding/setup"; $guzzleParams = [ 'query' => [], @@ -1892,8 +1837,7 @@ public function createFundingRequest($id, $model) * @param int $id The ID of the company you wish to delete. * @return ErrorDetail[] */ - public function deleteCompany($id) - { + public function deleteCompany($id) { $path = "/api/v2/companies/{$id}"; $guzzleParams = [ 'query' => [], @@ -1919,8 +1863,7 @@ public function deleteCompany($id) * @param int $companyId The unique identifier of the company * @return FundingConfigurationModel */ - public function fundingConfigurationByCompany($companyId) - { + public function fundingConfigurationByCompany($companyId) { $path = "/api/v2/companies/{$companyId}/funding/configuration"; $guzzleParams = [ 'query' => [], @@ -1947,8 +1890,7 @@ public function fundingConfigurationByCompany($companyId) * @param string $currency The currency of the funding. USD and CAD are the only valid currencies * @return FundingConfigurationModel[] */ - public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) - { + public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) { $path = "/api/v2/companies/{$companyId}/funding/configurations"; $guzzleParams = [ 'query' => ['currency' => $currency], @@ -1983,8 +1925,7 @@ public function fundingConfigurationsByCompanyAndCurrency($companyId, $currency) * @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 CompanyModel */ - public function getCompany($id, $include=null) - { + public function getCompany($id, $include=null) { $path = "/api/v2/companies/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -2017,8 +1958,7 @@ public function getCompany($id, $include=null) * @param int $id * @return CompanyConfigurationModel[] */ - public function getCompanyConfiguration($id) - { + public function getCompanyConfiguration($id) { $path = "/api/v2/companies/{$id}/configuration"; $guzzleParams = [ 'query' => [], @@ -2052,8 +1992,7 @@ public function getCompanyConfiguration($id) * @param int $id * @return string */ - public function getFilingStatus($id) - { + public function getFilingStatus($id) { $path = "/api/v2/companies/{$id}/filingstatus"; $guzzleParams = [ 'query' => [], @@ -2079,8 +2018,7 @@ public function getFilingStatus($id) * @param int $id The unique identifier of the company * @return FundingStatusModel[] */ - public function listFundingRequestsByCompany($id) - { + public function listFundingRequestsByCompany($id) { $path = "/api/v2/companies/{$id}/funding"; $guzzleParams = [ 'query' => [], @@ -2103,8 +2041,7 @@ public function listFundingRequestsByCompany($id) * * @return FetchResult */ - public function listMrsCompanies() - { + public function listMrsCompanies() { $path = "/api/v2/companies/mrs"; $guzzleParams = [ 'query' => [], @@ -2146,8 +2083,7 @@ public function listMrsCompanies() * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryCompanies($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -2181,8 +2117,7 @@ public function queryCompanies($include=null, $filter=null, $top=null, $skip=nul * @param CompanyConfigurationModel[] $model * @return CompanyConfigurationModel[] */ - public function setCompanyConfiguration($id, $model) - { + public function setCompanyConfiguration($id, $model) { $path = "/api/v2/companies/{$id}/configuration"; $guzzleParams = [ 'query' => [], @@ -2215,8 +2150,7 @@ public function setCompanyConfiguration($id, $model) * @param CompanyModel $model The company object you wish to update. * @return CompanyModel */ - public function updateCompany($id, $model) - { + public function updateCompany($id, $model) { $path = "/api/v2/companies/{$id}"; $guzzleParams = [ 'query' => [], @@ -2235,8 +2169,7 @@ public function updateCompany($id, $model) * @param TransactionReferenceFieldModel[] $model * @return FetchResult */ - public function tagTransaction($companyId, $model) - { + public function tagTransaction($companyId, $model) { $path = "/api/v2/companies/{$companyId}/transactions/tag"; $guzzleParams = [ 'query' => [], @@ -2261,8 +2194,7 @@ public function tagTransaction($companyId, $model) * @param ContactModel[] $model The contacts you wish to create. * @return ContactModel[] */ - public function createContacts($companyId, $model) - { + public function createContacts($companyId, $model) { $path = "/api/v2/companies/{$companyId}/contacts"; $guzzleParams = [ 'query' => [], @@ -2285,8 +2217,7 @@ public function createContacts($companyId, $model) * @param int $id The ID of the contact you wish to delete. * @return ErrorDetail[] */ - public function deleteContact($companyId, $id) - { + public function deleteContact($companyId, $id) { $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; $guzzleParams = [ 'query' => [], @@ -2311,8 +2242,7 @@ public function deleteContact($companyId, $id) * @param int $id The primary key of this contact * @return ContactModel */ - public function getContact($companyId, $id) - { + public function getContact($companyId, $id) { $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; $guzzleParams = [ 'query' => [], @@ -2341,8 +2271,7 @@ public function getContact($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listContactsByCompany($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -2372,8 +2301,7 @@ public function listContactsByCompany($companyId, $filter=null, $top=null, $skip * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryContacts($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -2401,8 +2329,7 @@ public function queryContacts($filter=null, $top=null, $skip=null, $orderBy=null * @param ContactModel $model The contact you wish to update. * @return ContactModel */ - public function updateContact($companyId, $id, $model) - { + public function updateContact($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/contacts/{$id}"; $guzzleParams = [ 'query' => [], @@ -2440,8 +2367,7 @@ public function updateContact($companyId, $id, $model) * @param CustomerModel[] $model The list of customer objects to be created * @return CustomerModel[] */ - public function createCustomers($companyId, $model) - { + public function createCustomers($companyId, $model) { $path = "/api/v2/companies/{$companyId}/customers"; $guzzleParams = [ 'query' => [], @@ -2476,8 +2402,7 @@ public function createCustomers($companyId, $model) * @param string $customerCode The unique code representing this customer * @return CustomerModel */ - public function deleteCustomer($companyId, $customerCode) - { + public function deleteCustomer($companyId, $customerCode) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; $guzzleParams = [ 'query' => [], @@ -2519,8 +2444,7 @@ public function deleteCustomer($companyId, $customerCode) * @param string $include Specify optional additional objects to include in this fetch request * @return CustomerModel */ - public function getCustomer($companyId, $customerCode, $include=null) - { + public function getCustomer($companyId, $customerCode, $include=null) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -2559,8 +2483,7 @@ public function getCustomer($companyId, $customerCode, $include=null) * @param CustomerAttributeModel[] $model The list of attributes to link to the customer. * @return FetchResult */ - public function linkAttributesToCustomer($companyId, $customerCode, $model) - { + public function linkAttributesToCustomer($companyId, $customerCode, $model) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes/link"; $guzzleParams = [ 'query' => [], @@ -2596,8 +2519,7 @@ public function linkAttributesToCustomer($companyId, $customerCode, $model) * @param LinkCertificatesModel $model The list of certificates to link to this customer * @return FetchResult */ - public function linkCertificatesToCustomer($companyId, $customerCode, $model) - { + public function linkCertificatesToCustomer($companyId, $customerCode, $model) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/link"; $guzzleParams = [ 'query' => [], @@ -2634,8 +2556,7 @@ public function linkCertificatesToCustomer($companyId, $customerCode, $model) * @param LinkCustomersModel $model A list of information about ship-to customers to link to this bill-to customer. * @return CustomerModel */ - public function linkShipToCustomersToBillCustomer($companyId, $code, $model) - { + public function linkShipToCustomersToBillCustomer($companyId, $code, $model) { $path = "/api/v2/companies/{$companyId}/customers/billto/{$code}/shipto/link"; $guzzleParams = [ 'query' => [], @@ -2673,8 +2594,7 @@ public function linkShipToCustomersToBillCustomer($companyId, $code, $model) * @param string $customerCode The unique code representing the current customer * @return FetchResult */ - public function listAttributesForCustomer($companyId, $customerCode) - { + public function listAttributesForCustomer($companyId, $customerCode) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes"; $guzzleParams = [ 'query' => [], @@ -2714,8 +2634,7 @@ public function listAttributesForCustomer($companyId, $customerCode) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCertificatesForCustomer($companyId, $customerCode, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -2755,8 +2674,7 @@ public function listCertificatesForCustomer($companyId, $customerCode, $include= * @param string $region Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code. * @return ExemptionStatusModel */ - public function listValidCertificatesForCustomer($companyId, $customerCode, $country, $region) - { + public function listValidCertificatesForCustomer($companyId, $customerCode, $country, $region) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/{$country}/{$region}"; $guzzleParams = [ 'query' => [], @@ -2800,8 +2718,7 @@ public function listValidCertificatesForCustomer($companyId, $customerCode, $cou * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryCustomers($companyId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -2840,8 +2757,7 @@ public function queryCustomers($companyId, $include=null, $filter=null, $top=nul * @param CustomerAttributeModel[] $model The list of attributes to unlink from the customer. * @return FetchResult */ - public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) - { + public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/attributes/unlink"; $guzzleParams = [ 'query' => [], @@ -2877,8 +2793,7 @@ public function unlinkAttributesFromCustomer($companyId, $customerCode, $model) * @param LinkCertificatesModel $model The list of certificates to link to this customer * @return FetchResult */ - public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model) - { + public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}/certificates/unlink"; $guzzleParams = [ 'query' => [], @@ -2914,8 +2829,7 @@ public function unlinkCertificatesFromCustomer($companyId, $customerCode, $model * @param CustomerModel $model The new customer model that will replace the existing record at this URL * @return CustomerModel */ - public function updateCustomer($companyId, $customerCode, $model) - { + public function updateCustomer($companyId, $customerCode, $model) { $path = "/api/v2/companies/{$companyId}/customers/{$customerCode}"; $guzzleParams = [ 'query' => [], @@ -2939,8 +2853,7 @@ public function updateCustomer($companyId, $customerCode, $model) * @param DataSourceModel[] $model * @return DataSourceModel[] */ - public function createDataSources($companyId, $model) - { + public function createDataSources($companyId, $model) { $path = "/api/v2/companies/{$companyId}/datasources"; $guzzleParams = [ 'query' => [], @@ -2964,8 +2877,7 @@ public function createDataSources($companyId, $model) * @param int $id The id of the datasource you wish to delete. * @return ErrorDetail[] */ - public function deleteDataSource($companyId, $id) - { + public function deleteDataSource($companyId, $id) { $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; $guzzleParams = [ 'query' => [], @@ -2989,8 +2901,7 @@ public function deleteDataSource($companyId, $id) * @param int $id data source id * @return DataSourceModel */ - public function getDataSourceById($companyId, $id) - { + public function getDataSourceById($companyId, $id) { $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; $guzzleParams = [ 'query' => [], @@ -3017,8 +2928,7 @@ public function getDataSourceById($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listDataSources($companyId, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3047,8 +2957,7 @@ public function listDataSources($companyId, $filter=null, $top=null, $skip=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryDataSources($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3073,8 +2982,7 @@ public function queryDataSources($filter=null, $top=null, $skip=null, $orderBy=n * @param DataSourceModel $model * @return DataSourceModel */ - public function updateDataSource($companyId, $id, $model) - { + public function updateDataSource($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/datasources/{$id}"; $guzzleParams = [ 'query' => [], @@ -3106,8 +3014,7 @@ public function updateDataSource($companyId, $id, $model) * @param string $hsCode The partial or full HS Code for which you would like to view all of the parents. * @return FetchResult */ - public function getCrossBorderCode($country, $hsCode) - { + public function getCrossBorderCode($country, $hsCode) { $path = "/api/v2/definitions/crossborder/{$country}/{$hsCode}/hierarchy"; $guzzleParams = [ 'query' => [], @@ -3130,8 +3037,7 @@ public function getCrossBorderCode($country, $hsCode) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function getLoginVerifierByForm($form, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3157,8 +3063,7 @@ public function getLoginVerifierByForm($form, $filter=null, $top=null, $skip=nul * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listAvaFileForms($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3186,8 +3091,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 FetchResult */ - public function listCertificateAttributes($companyid, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3214,8 +3118,7 @@ public function listCertificateAttributes($companyid, $filter=null, $top=null, $ * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCertificateExemptReasons($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3242,8 +3145,7 @@ public function listCertificateExemptReasons($filter=null, $top=null, $skip=null * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCertificateExposureZones($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3265,8 +3167,7 @@ public function listCertificateExposureZones($filter=null, $top=null, $skip=null * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCommunicationsServiceTypes($id, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3288,8 +3189,7 @@ public function listCommunicationsServiceTypes($id, $filter=null, $top=null, $sk * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCommunicationsTransactionTypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3311,8 +3211,7 @@ public function listCommunicationsTransactionTypes($filter=null, $top=null, $ski * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCommunicationsTSPairs($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3335,8 +3234,7 @@ public function listCommunicationsTSPairs($filter=null, $top=null, $skip=null, $ * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCountries($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3364,8 +3262,7 @@ public function listCountries($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 FetchResult */ - public function listCoverLetters($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3399,8 +3296,7 @@ public function listCoverLetters($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 FetchResult */ - public function listCrossBorderCodes($country, $hsCode, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3426,8 +3322,7 @@ public function listCrossBorderCodes($country, $hsCode, $filter=null, $top=null, * * @return FetchResult */ - public function listCrossBorderSections() - { + public function listCrossBorderSections() { $path = "/api/v2/definitions/crossborder/sections"; $guzzleParams = [ 'query' => [], @@ -3451,8 +3346,7 @@ public function listCrossBorderSections() * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listCurrencies($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3477,8 +3371,7 @@ public function listCurrencies($filter=null, $top=null, $skip=null, $orderBy=nul * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listEntityUseCodes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3500,8 +3393,7 @@ public function listEntityUseCodes($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 FetchResult */ - public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3527,8 +3419,7 @@ public function listFilingFrequencies($filter=null, $top=null, $skip=null, $orde * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listJurisdictions($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3562,8 +3453,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 FetchResult */ - public function listJurisdictionsByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3598,8 +3488,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 FetchResult */ - public function listLocationQuestionsByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $latitude, $longitude, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3622,8 +3511,7 @@ public function listLocationQuestionsByAddress($line1, $line2, $line3, $city, $r * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listLoginVerifiers($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3644,8 +3532,7 @@ public function listLoginVerifiers($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 FetchResult */ - public function listMarketplaceLocations($marketplaceId, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3668,8 +3555,7 @@ public function listMarketplaceLocations($marketplaceId, $top=null, $skip=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNexus($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3701,8 +3587,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 FetchResult */ - public function listNexusByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3726,8 +3611,7 @@ public function listNexusByAddress($line1, $line2, $line3, $city, $region, $post * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNexusByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3752,8 +3636,7 @@ public function listNexusByCountry($country, $filter=null, $top=null, $skip=null * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNexusByCountryAndRegion($country, $region, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3785,8 +3668,7 @@ public function listNexusByCountryAndRegion($country, $region, $filter=null, $to * @param string $formCode The form code that we are looking up the nexus for * @return NexusByTaxFormModel */ - public function listNexusByFormCode($formCode) - { + public function listNexusByFormCode($formCode) { $path = "/api/v2/definitions/nexus/byform/{$formCode}"; $guzzleParams = [ 'query' => [], @@ -3808,8 +3690,7 @@ public function listNexusByFormCode($formCode) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNexusTaxTypeGroups($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3831,8 +3712,7 @@ public function listNexusTaxTypeGroups($filter=null, $top=null, $skip=null, $ord * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNoticeCustomerFundingOptions($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3854,8 +3734,7 @@ public function listNoticeCustomerFundingOptions($filter=null, $top=null, $skip= * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNoticeCustomerTypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3877,8 +3756,7 @@ public function listNoticeCustomerTypes($filter=null, $top=null, $skip=null, $or * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNoticeFilingtypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3900,8 +3778,7 @@ public function listNoticeFilingtypes($filter=null, $top=null, $skip=null, $orde * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNoticePriorities($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3923,8 +3800,7 @@ public function listNoticePriorities($filter=null, $top=null, $skip=null, $order * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNoticeReasons($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3946,8 +3822,7 @@ public function listNoticeReasons($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 FetchResult */ - public function listNoticeResponsibilities($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3969,8 +3844,7 @@ public function listNoticeResponsibilities($filter=null, $top=null, $skip=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNoticeRootCauses($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -3992,8 +3866,7 @@ public function listNoticeRootCauses($filter=null, $top=null, $skip=null, $order * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNoticeStatuses($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4015,8 +3888,7 @@ public function listNoticeStatuses($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 FetchResult */ - public function listNoticeTypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4039,8 +3911,7 @@ public function listNoticeTypes($filter=null, $top=null, $skip=null, $orderBy=nu * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listParameters($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4067,8 +3938,7 @@ public function listParameters($filter=null, $top=null, $skip=null, $orderBy=nul * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listParametersByItem($companyCode, $itemCode, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4091,8 +3961,7 @@ public function listParametersByItem($companyCode, $itemCode, $filter=null, $top * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listParametersUsage($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4112,8 +3981,7 @@ public function listParametersUsage($filter=null, $top=null, $skip=null, $orderB * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @return FetchResult */ - public function listPermissions($top=null, $skip=null) - { + public function listPermissions($top=null, $skip=null) { $path = "/api/v2/definitions/permissions"; $guzzleParams = [ 'query' => ['$top' => $top, '$skip' => $skip], @@ -4134,8 +4002,7 @@ public function listPermissions($top=null, $skip=null) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listPostalCodes($filter=null, $top=null, $skip=null, $orderBy=null) - { + public function listPostalCodes($filter=null, $top=null, $skip=null, $orderBy=null) { $path = "/api/v2/definitions/postalcodes"; $guzzleParams = [ 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], @@ -4164,8 +4031,7 @@ public function listPostalCodes($filter=null, $top=null, $skip=null, $orderBy=nu * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listPreferredPrograms($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4190,8 +4056,7 @@ public function listPreferredPrograms($filter=null, $top=null, $skip=null, $orde * @param string $countryCode If not null, return all records with this code. * @return FetchResult */ - public function listProductClassificationSystems($filter=null, $top=null, $skip=null, $orderBy=null, $countryCode) - { + public function listProductClassificationSystems($filter=null, $top=null, $skip=null, $orderBy=null, $countryCode) { $path = "/api/v2/definitions/productclassificationsystems"; $guzzleParams = [ 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], @@ -4217,8 +4082,7 @@ public function listProductClassificationSystems($filter=null, $top=null, $skip= * @param string $countryCode If not null, return all records with this code. * @return FetchResult */ - public function listProductClassificationSystemsByCompany($companyCode, $filter=null, $top=null, $skip=null, $orderBy=null, $countryCode) - { + public function listProductClassificationSystemsByCompany($companyCode, $filter=null, $top=null, $skip=null, $orderBy=null, $countryCode) { $path = "/api/v2/definitions/productclassificationsystems/bycompany/{$companyCode}"; $guzzleParams = [ 'query' => ['$filter' => $filter, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy, '$countryCode' => $countryCode], @@ -4241,8 +4105,7 @@ public function listProductClassificationSystemsByCompany($companyCode, $filter= * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listRateTypesByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4265,8 +4128,7 @@ public function listRateTypesByCountry($country, $filter=null, $top=null, $skip= * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listRegions($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4290,8 +4152,7 @@ public function listRegions($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 FetchResult */ - public function listRegionsByCountry($country, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4313,8 +4174,7 @@ public function listRegionsByCountry($country, $filter=null, $top=null, $skip=nu * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listResourceFileTypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4337,8 +4197,7 @@ public function listResourceFileTypes($filter=null, $top=null, $skip=null, $orde * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listSecurityRoles($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4362,8 +4221,7 @@ public function listSecurityRoles($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 FetchResult */ - public function listSubscriptionTypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4385,8 +4243,7 @@ public function listSubscriptionTypes($filter=null, $top=null, $skip=null, $orde * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTaxAuthorities($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4410,8 +4267,7 @@ public function listTaxAuthorities($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 FetchResult */ - public function listTaxAuthorityForms($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4433,8 +4289,7 @@ public function listTaxAuthorityForms($filter=null, $top=null, $skip=null, $orde * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTaxAuthorityTypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4463,8 +4318,7 @@ public function listTaxAuthorityTypes($filter=null, $top=null, $skip=null, $orde * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTaxCodes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4485,8 +4339,7 @@ public function listTaxCodes($filter=null, $top=null, $skip=null, $orderBy=null) * @param int $skip If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets. * @return TaxCodeTypesModel */ - public function listTaxCodeTypes($top=null, $skip=null) - { + public function listTaxCodeTypes($top=null, $skip=null) { $path = "/api/v2/definitions/taxcodetypes"; $guzzleParams = [ 'query' => ['$top' => $top, '$skip' => $skip], @@ -4508,8 +4361,7 @@ public function listTaxCodeTypes($top=null, $skip=null) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTaxForms($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4531,8 +4383,7 @@ public function listTaxForms($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 FetchResult */ - public function listTaxSubTypes($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4554,8 +4405,7 @@ public function listTaxSubTypes($filter=null, $top=null, $skip=null, $orderBy=nu * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTaxTypeGroups($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4578,8 +4428,7 @@ public function listTaxTypeGroups($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 FetchResult */ - public function listUnitOfMeasurement($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4606,8 +4455,7 @@ public function listUnitOfMeasurement($filter=null, $top=null, $skip=null, $orde * @param CompanyDistanceThresholdModel[] $model The DistanceThreshold object or objects you wish to create. * @return CompanyDistanceThresholdModel[] */ - public function createDistanceThreshold($companyId, $model) - { + public function createDistanceThreshold($companyId, $model) { $path = "/api/v2/companies/{$companyId}/distancethresholds"; $guzzleParams = [ 'query' => [], @@ -4634,8 +4482,7 @@ public function createDistanceThreshold($companyId, $model) * @param int $id The unique ID number of the DistanceThreshold object you wish to delete. * @return ErrorDetail[] */ - public function deleteDistanceThreshold($companyId, $id) - { + public function deleteDistanceThreshold($companyId, $id) { $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; $guzzleParams = [ 'query' => [], @@ -4662,8 +4509,7 @@ public function deleteDistanceThreshold($companyId, $id) * @param int $id The unique ID number referring to this DistanceThreshold object * @return CompanyDistanceThresholdModel */ - public function getDistanceThreshold($companyId, $id) - { + public function getDistanceThreshold($companyId, $id) { $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; $guzzleParams = [ 'query' => [], @@ -4694,8 +4540,7 @@ public function getDistanceThreshold($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listDistanceThresholds($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4728,8 +4573,7 @@ public function listDistanceThresholds($companyId, $filter=null, $include=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryDistanceThresholds($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -4760,8 +4604,7 @@ public function queryDistanceThresholds($filter=null, $include=null, $top=null, * @param CompanyDistanceThresholdModel $model The new DistanceThreshold object to store. * @return CompanyDistanceThresholdModel */ - public function updateDistanceThreshold($companyId, $id, $model) - { + public function updateDistanceThreshold($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/distancethresholds/{$id}"; $guzzleParams = [ 'query' => [], @@ -4785,8 +4628,7 @@ public function updateDistanceThreshold($companyId, $id, $model) * @param int $companyReturnSettingId The unique ID of the company return setting that will be deleted from the filing calendar * @return CompanyReturnSettingModel[] */ - public function deleteCompanyReturnSettings($companyId, $filingCalendarId, $companyReturnSettingId) - { + public function deleteCompanyReturnSettings($companyId, $filingCalendarId, $companyReturnSettingId) { $path = "/api/v2/companies/{$companyId}/filingcalendars/{$filingCalendarId}/setting/{$companyReturnSettingId}"; $guzzleParams = [ 'query' => [], @@ -4816,8 +4658,7 @@ public function deleteCompanyReturnSettings($companyId, $filingCalendarId, $comp * @param string $taxformCode The unique tax form code of the form. * @return FetchResult */ - public function getFiledReturns($companyId, $endPeriodMonth, $endPeriodYear, $frequency, $status, $country, $region, $filingCalendarId, $taxformCode) - { + public function getFiledReturns($companyId, $endPeriodMonth, $endPeriodYear, $frequency, $status, $country, $region, $filingCalendarId, $taxformCode) { $path = "/api/v2/companies/{$companyId}/filings/returns/filed"; $guzzleParams = [ 'query' => ['endPeriodMonth' => $endPeriodMonth, 'endPeriodYear' => $endPeriodYear, 'frequency' => $frequency, 'status' => $status, 'country' => $country, 'region' => $region, 'filingCalendarId' => $filingCalendarId, 'taxformCode' => $taxformCode], @@ -4839,8 +4680,7 @@ public function getFiledReturns($companyId, $endPeriodMonth, $endPeriodYear, $fr * @param int $id * @return FirmClientLinkageOutputModel */ - public function approveFirmClientLinkage($id) - { + public function approveFirmClientLinkage($id) { $path = "/api/v2/firmclientlinkages/{$id}/approve"; $guzzleParams = [ 'query' => [], @@ -4871,8 +4711,7 @@ public function approveFirmClientLinkage($id) * @param NewFirmClientAccountRequestModel $model Information about the account you wish to create. * @return FirmClientLinkageOutputModel */ - public function createAndLinkNewFirmClientAccount($model) - { + public function createAndLinkNewFirmClientAccount($model) { $path = "/api/v2/firmclientlinkages/createandlinkclient"; $guzzleParams = [ 'query' => [], @@ -4894,8 +4733,7 @@ public function createAndLinkNewFirmClientAccount($model) * @param FirmClientLinkageInputModel $model FirmClientLinkageInputModel * @return FirmClientLinkageOutputModel */ - public function createFirmClientLinkage($model) - { + public function createFirmClientLinkage($model) { $path = "/api/v2/firmclientlinkages"; $guzzleParams = [ 'query' => [], @@ -4917,8 +4755,7 @@ public function createFirmClientLinkage($model) * @param int $id * @return ErrorDetail[] */ - public function deleteFirmClientLinkage($id) - { + public function deleteFirmClientLinkage($id) { $path = "/api/v2/firmclientlinkages/{$id}"; $guzzleParams = [ 'query' => [], @@ -4940,8 +4777,7 @@ public function deleteFirmClientLinkage($id) * @param int $id * @return FirmClientLinkageOutputModel */ - public function getFirmClientLinkage($id) - { + public function getFirmClientLinkage($id) { $path = "/api/v2/firmclientlinkages/{$id}"; $guzzleParams = [ 'query' => [], @@ -4963,8 +4799,7 @@ public function getFirmClientLinkage($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:* firmAccountName, clientAccountName * @return FetchResult */ - public function listFirmClientLinkage($filter=null) - { + public function listFirmClientLinkage($filter=null) { $path = "/api/v2/firmclientlinkages"; $guzzleParams = [ 'query' => ['$filter' => $filter], @@ -4986,8 +4821,7 @@ public function listFirmClientLinkage($filter=null) * @param int $id * @return FirmClientLinkageOutputModel */ - public function rejectFirmClientLinkage($id) - { + public function rejectFirmClientLinkage($id) { $path = "/api/v2/firmclientlinkages/{$id}/reject"; $guzzleParams = [ 'query' => [], @@ -5009,8 +4843,7 @@ public function rejectFirmClientLinkage($id) * @param int $id * @return FirmClientLinkageOutputModel */ - public function resetFirmClientLinkage($id) - { + public function resetFirmClientLinkage($id) { $path = "/api/v2/firmclientlinkages/{$id}/reset"; $guzzleParams = [ 'query' => [], @@ -5032,8 +4865,7 @@ public function resetFirmClientLinkage($id) * @param int $id * @return FirmClientLinkageOutputModel */ - public function revokeFirmClientLinkage($id) - { + public function revokeFirmClientLinkage($id) { $path = "/api/v2/firmclientlinkages/{$id}/revoke"; $guzzleParams = [ 'query' => [], @@ -5064,8 +4896,7 @@ public function revokeFirmClientLinkage($id) * @param FreeTrialRequestModel $model Required information to provision a free trial account. * @return NewAccountModel */ - public function requestFreeTrial($model) - { + public function requestFreeTrial($model) { $path = "/api/v2/accounts/freetrials/request"; $guzzleParams = [ 'query' => [], @@ -5113,8 +4944,7 @@ public function requestFreeTrial($model) * @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 TaxRateModel */ - public function taxRatesByAddress($line1, $line2, $line3, $city, $region, $postalCode, $country) - { + 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], @@ -5159,8 +4989,7 @@ public function taxRatesByAddress($line1, $line2, $line3, $city, $region, $posta * @param string $postalCode The postal code of the location. * @return TaxRateModel */ - public function taxRatesByPostalCode($country, $postalCode) - { + public function taxRatesByPostalCode($country, $postalCode) { $path = "/api/v2/taxrates/bypostalcode"; $guzzleParams = [ 'query' => ['country' => $country, 'postalCode' => $postalCode], @@ -5194,8 +5023,7 @@ public function taxRatesByPostalCode($country, $postalCode) * @param int $id The unique ID number of this funding request * @return FundingStatusModel */ - public function activateFundingRequest($id) - { + public function activateFundingRequest($id) { $path = "/api/v2/fundingrequests/{$id}/widget"; $guzzleParams = [ 'query' => [], @@ -5227,8 +5055,7 @@ public function activateFundingRequest($id) * @param int $id The unique ID number of this funding request * @return FundingStatusModel */ - public function fundingRequestStatus($id) - { + public function fundingRequestStatus($id) { $path = "/api/v2/fundingrequests/{$id}"; $guzzleParams = [ 'query' => [], @@ -5255,8 +5082,7 @@ public function fundingRequestStatus($id) * @param int $itemId The ID of the item you wish to delete the classifications. * @return ErrorDetail[] */ - public function batchDeleteItemClassifications($companyId, $itemId) - { + public function batchDeleteItemClassifications($companyId, $itemId) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; $guzzleParams = [ 'query' => [], @@ -5285,8 +5111,7 @@ public function batchDeleteItemClassifications($companyId, $itemId) * @param int $itemId The ID of the item you wish to delete the parameters. * @return ErrorDetail[] */ - public function batchDeleteItemParameters($companyId, $itemId) - { + public function batchDeleteItemParameters($companyId, $itemId) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; $guzzleParams = [ 'query' => [], @@ -5316,8 +5141,7 @@ public function batchDeleteItemParameters($companyId, $itemId) * @param ItemClassificationInputModel[] $model The item classifications you wish to create. * @return ItemClassificationOutputModel[] */ - public function createItemClassifications($companyId, $itemId, $model) - { + public function createItemClassifications($companyId, $itemId, $model) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications"; $guzzleParams = [ 'query' => [], @@ -5351,8 +5175,7 @@ public function createItemClassifications($companyId, $itemId, $model) * @param ItemParameterModel[] $model The item parameters you wish to create. * @return ItemParameterModel[] */ - public function createItemParameters($companyId, $itemId, $model) - { + public function createItemParameters($companyId, $itemId, $model) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters"; $guzzleParams = [ 'query' => [], @@ -5383,8 +5206,7 @@ public function createItemParameters($companyId, $itemId, $model) * @param ItemModel[] $model The item you wish to create. * @return ItemModel[] */ - public function createItems($companyId, $model) - { + public function createItems($companyId, $model) { $path = "/api/v2/companies/{$companyId}/items"; $guzzleParams = [ 'query' => [], @@ -5415,8 +5237,7 @@ public function createItems($companyId, $model) * @param int $id The ID of the item you wish to delete. * @return ErrorDetail[] */ - public function deleteItem($companyId, $id) - { + public function deleteItem($companyId, $id) { $path = "/api/v2/companies/{$companyId}/items/{$id}"; $guzzleParams = [ 'query' => [], @@ -5444,8 +5265,7 @@ public function deleteItem($companyId, $id) * @param int $id The item classification id. * @return ErrorDetail[] */ - public function deleteItemClassification($companyId, $itemId, $id) - { + public function deleteItemClassification($companyId, $itemId, $id) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; $guzzleParams = [ 'query' => [], @@ -5475,8 +5295,7 @@ public function deleteItemClassification($companyId, $itemId, $id) * @param int $id The parameter id * @return ErrorDetail[] */ - public function deleteItemParameter($companyId, $itemId, $id) - { + public function deleteItemParameter($companyId, $itemId, $id) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; $guzzleParams = [ 'query' => [], @@ -5506,8 +5325,7 @@ public function deleteItemParameter($companyId, $itemId, $id) * @param string $include A comma separated list of additional data to retrieve. * @return ItemModel */ - public function getItem($companyId, $id, $include=null) - { + public function getItem($companyId, $id, $include=null) { $path = "/api/v2/companies/{$companyId}/items/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -5535,8 +5353,7 @@ public function getItem($companyId, $id, $include=null) * @param int $id The item classification id. * @return ItemClassificationOutputModel */ - public function getItemClassification($companyId, $itemId, $id) - { + public function getItemClassification($companyId, $itemId, $id) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; $guzzleParams = [ 'query' => [], @@ -5566,8 +5383,7 @@ public function getItemClassification($companyId, $itemId, $id) * @param int $id The parameter id * @return ItemParameterModel */ - public function getItemParameter($companyId, $itemId, $id) - { + public function getItemParameter($companyId, $itemId, $id) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; $guzzleParams = [ 'query' => [], @@ -5601,8 +5417,7 @@ public function getItemParameter($companyId, $itemId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listItemClassifications($companyId, $itemId, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -5638,8 +5453,7 @@ public function listItemClassifications($companyId, $itemId, $filter=null, $top= * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listItemParameters($companyId, $itemId, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -5681,8 +5495,7 @@ public function listItemParameters($companyId, $itemId, $filter=null, $top=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listItemsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + public function listItemsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) { $path = "/api/v2/companies/{$companyId}/items"; $guzzleParams = [ 'query' => ['$filter' => $filter, '$include' => $include, '$top' => $top, '$skip' => $skip, '$orderBy' => $orderBy], @@ -5718,8 +5531,7 @@ public function listItemsByCompany($companyId, $filter=null, $include=null, $top * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryItems($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -5753,8 +5565,7 @@ public function queryItems($filter=null, $include=null, $top=null, $skip=null, $ * @param SyncItemsRequestModel $model The request object. * @return SyncItemsResponseModel */ - public function syncItems($companyId, $model) - { + public function syncItems($companyId, $model) { $path = "/api/v2/companies/{$companyId}/items/sync"; $guzzleParams = [ 'query' => [], @@ -5789,8 +5600,7 @@ public function syncItems($companyId, $model) * @param ItemModel $model The item object you wish to update. * @return ItemModel */ - public function updateItem($companyId, $id, $model) - { + public function updateItem($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/items/{$id}"; $guzzleParams = [ 'query' => [], @@ -5821,8 +5631,7 @@ public function updateItem($companyId, $id, $model) * @param ItemClassificationInputModel $model The item object you wish to update. * @return ItemClassificationOutputModel */ - public function updateItemClassification($companyId, $itemId, $id, $model) - { + public function updateItemClassification($companyId, $itemId, $id, $model) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/classifications/{$id}"; $guzzleParams = [ 'query' => [], @@ -5853,8 +5662,7 @@ public function updateItemClassification($companyId, $itemId, $id, $model) * @param ItemParameterModel $model The item object you wish to update. * @return ItemParameterModel */ - public function updateItemParameter($companyId, $itemId, $id, $model) - { + public function updateItemParameter($companyId, $itemId, $id, $model) { $path = "/api/v2/companies/{$companyId}/items/{$itemId}/parameters/{$id}"; $guzzleParams = [ 'query' => [], @@ -5882,8 +5690,7 @@ public function updateItemParameter($companyId, $itemId, $id, $model) * @param JurisdictionOverrideModel[] $model The jurisdiction override objects to create * @return JurisdictionOverrideModel[] */ - public function createJurisdictionOverrides($accountId, $model) - { + public function createJurisdictionOverrides($accountId, $model) { $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides"; $guzzleParams = [ 'query' => [], @@ -5906,8 +5713,7 @@ public function createJurisdictionOverrides($accountId, $model) * @param int $id The ID of the override you wish to delete * @return ErrorDetail[] */ - public function deleteJurisdictionOverride($accountId, $id) - { + public function deleteJurisdictionOverride($accountId, $id) { $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; $guzzleParams = [ 'query' => [], @@ -5935,8 +5741,7 @@ public function deleteJurisdictionOverride($accountId, $id) * @param int $id The primary key of this override * @return JurisdictionOverrideModel */ - public function getJurisdictionOverride($accountId, $id) - { + public function getJurisdictionOverride($accountId, $id) { $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; $guzzleParams = [ 'query' => [], @@ -5971,8 +5776,7 @@ public function getJurisdictionOverride($accountId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listJurisdictionOverridesByAccount($accountId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -6006,8 +5810,7 @@ public function listJurisdictionOverridesByAccount($accountId, $filter=null, $in * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryJurisdictionOverrides($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -6031,8 +5834,7 @@ public function queryJurisdictionOverrides($filter=null, $include=null, $top=nul * @param JurisdictionOverrideModel $model The jurisdictionoverride object you wish to update. * @return JurisdictionOverrideModel */ - public function updateJurisdictionOverride($accountId, $id, $model) - { + public function updateJurisdictionOverride($accountId, $id, $model) { $path = "/api/v2/accounts/{$accountId}/jurisdictionoverrides/{$id}"; $guzzleParams = [ 'query' => [], @@ -6055,8 +5857,7 @@ public function updateJurisdictionOverride($accountId, $id, $model) * @param LocationModel[] $model The location you wish to create. * @return LocationModel[] */ - public function createLocations($companyId, $model) - { + public function createLocations($companyId, $model) { $path = "/api/v2/companies/{$companyId}/locations"; $guzzleParams = [ 'query' => [], @@ -6079,8 +5880,7 @@ public function createLocations($companyId, $model) * @param int $id The ID of the location you wish to delete. * @return ErrorDetail[] */ - public function deleteLocation($companyId, $id) - { + public function deleteLocation($companyId, $id) { $path = "/api/v2/companies/{$companyId}/locations/{$id}"; $guzzleParams = [ 'query' => [], @@ -6113,8 +5913,7 @@ public function deleteLocation($companyId, $id) * @param string $include A comma separated list of additional data to retrieve. * @return LocationModel */ - public function getLocation($companyId, $id, $include=null) - { + public function getLocation($companyId, $id, $include=null) { $path = "/api/v2/companies/{$companyId}/locations/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -6152,8 +5951,7 @@ public function getLocation($companyId, $id, $include=null) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listLocationsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -6191,8 +5989,7 @@ public function listLocationsByCompany($companyId, $filter=null, $include=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryLocations($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -6218,8 +6015,7 @@ public function queryLocations($filter=null, $include=null, $top=null, $skip=nul * @param LocationModel $model The location you wish to update. * @return LocationModel */ - public function updateLocation($companyId, $id, $model) - { + public function updateLocation($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/locations/{$id}"; $guzzleParams = [ 'query' => [], @@ -6244,8 +6040,7 @@ public function updateLocation($companyId, $id, $model) * @param int $id The primary key of this location * @return LocationValidationModel */ - public function validateLocation($companyId, $id) - { + public function validateLocation($companyId, $id) { $path = "/api/v2/companies/{$companyId}/locations/{$id}/validate"; $guzzleParams = [ 'query' => [], @@ -6288,8 +6083,7 @@ public function validateLocation($companyId, $id) * @param AdjustMultiDocumentModel $model The adjust request you wish to execute * @return MultiDocumentModel */ - public function adjustMultiDocumentTransaction($code, $type, $include=null, $model) - { + public function adjustMultiDocumentTransaction($code, $type, $include=null, $model) { $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/adjust"; $guzzleParams = [ 'query' => ['include' => $include], @@ -6334,8 +6128,7 @@ public function adjustMultiDocumentTransaction($code, $type, $include=null, $mod * @param string $type The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values) * @return AuditMultiDocumentModel */ - public function auditMultiDocumentTransaction($code, $type) - { + public function auditMultiDocumentTransaction($code, $type) { $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/audit"; $guzzleParams = [ 'query' => [], @@ -6373,8 +6166,7 @@ public function auditMultiDocumentTransaction($code, $type) * @param CommitMultiDocumentModel $model The commit request you wish to execute * @return MultiDocumentModel */ - public function commitMultiDocumentTransaction($model) - { + public function commitMultiDocumentTransaction($model) { $path = "/api/v2/transactions/multidocument/commit"; $guzzleParams = [ 'query' => [], @@ -6437,8 +6229,7 @@ public function commitMultiDocumentTransaction($model) * @param CreateMultiDocumentModel $model the multi document transaction model * @return MultiDocumentModel */ - public function createMultiDocumentTransaction($include=null, $model) - { + public function createMultiDocumentTransaction($include=null, $model) { $path = "/api/v2/transactions/multidocument"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -6482,8 +6273,7 @@ public function createMultiDocumentTransaction($include=null, $model) * @param string $include Specifies objects to include in the response after transaction is created * @return MultiDocumentModel */ - public function getMultiDocumentTransactionByCodeAndType($code, $type, $include=null) - { + public function getMultiDocumentTransactionByCodeAndType($code, $type, $include=null) { $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -6535,8 +6325,7 @@ public function getMultiDocumentTransactionByCodeAndType($code, $type, $include= * @param string $include Specifies objects to include in the response after transaction is created * @return MultiDocumentModel */ - public function getMultiDocumentTransactionById($id, $include=null) - { + public function getMultiDocumentTransactionById($id, $include=null) { $path = "/api/v2/transactions/multidocument/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -6589,8 +6378,7 @@ public function getMultiDocumentTransactionById($id, $include=null) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listMultiDocumentTransactions($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -6659,8 +6447,7 @@ public function listMultiDocumentTransactions($filter=null, $include=null, $top= * @param RefundTransactionModel $model Information about the refund to create * @return MultiDocumentModel */ - public function refundMultiDocumentTransaction($code, $type, $include=null, $model) - { + public function refundMultiDocumentTransaction($code, $type, $include=null, $model) { $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/refund"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -6696,8 +6483,7 @@ public function refundMultiDocumentTransaction($code, $type, $include=null, $mod * @param VerifyMultiDocumentModel $model Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax * @return MultiDocumentModel */ - public function verifyMultiDocumentTransaction($model) - { + public function verifyMultiDocumentTransaction($model) { $path = "/api/v2/transactions/multidocument/verify"; $guzzleParams = [ 'query' => [], @@ -6738,8 +6524,7 @@ public function verifyMultiDocumentTransaction($model) * @param VoidTransactionModel $model The void request you wish to execute * @return MultiDocumentModel */ - public function voidMultiDocumentTransaction($code, $type, $model) - { + public function voidMultiDocumentTransaction($code, $type, $model) { $path = "/api/v2/transactions/multidocument/{$code}/type/{$type}/void"; $guzzleParams = [ 'query' => [], @@ -6780,8 +6565,7 @@ public function voidMultiDocumentTransaction($code, $type, $model) * @param NexusModel[] $model The nexus you wish to create. * @return NexusModel[] */ - public function createNexus($companyId, $model) - { + public function createNexus($companyId, $model) { $path = "/api/v2/companies/{$companyId}/nexus"; $guzzleParams = [ 'query' => [], @@ -6818,8 +6602,7 @@ public function createNexus($companyId, $model) * @param DeclareNexusByAddressModel[] $model The nexus you wish to create. * @return NexusByAddressModel[] */ - public function declareNexusByAddress($companyId, $model) - { + public function declareNexusByAddress($companyId, $model) { $path = "/api/v2/companies/{$companyId}/nexus/byaddress"; $guzzleParams = [ 'query' => [], @@ -6850,8 +6633,7 @@ public function declareNexusByAddress($companyId, $model) * @param boolean $cascadeDelete If true, deletes all the child nexus if they exist along with parent nexus * @return ErrorDetail[] */ - public function deleteNexus($companyId, $id, $cascadeDelete) - { + public function deleteNexus($companyId, $id, $cascadeDelete) { $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; $guzzleParams = [ 'query' => ['cascadeDelete' => $cascadeDelete], @@ -6882,8 +6664,7 @@ public function deleteNexus($companyId, $id, $cascadeDelete) * @param string $include * @return NexusModel */ - public function getNexus($companyId, $id, $include=null) - { + public function getNexus($companyId, $id, $include=null) { $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -6918,8 +6699,7 @@ public function getNexus($companyId, $id, $include=null) * @param string $include * @return NexusByTaxFormModel */ - public function getNexusByFormCode($companyId, $formCode, $include=null) - { + public function getNexusByFormCode($companyId, $formCode, $include=null) { $path = "/api/v2/companies/{$companyId}/nexus/byform/{$formCode}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -6956,8 +6736,7 @@ public function getNexusByFormCode($companyId, $formCode, $include=null) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNexusByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -6993,8 +6772,7 @@ public function listNexusByCompany($companyId, $filter=null, $include=null, $top * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryNexus($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -7036,8 +6814,7 @@ public function queryNexus($filter=null, $include=null, $top=null, $skip=null, $ * @param NexusModel $model The nexus object you wish to update. * @return NexusModel */ - public function updateNexus($companyId, $id, $model) - { + public function updateNexus($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/nexus/{$id}"; $guzzleParams = [ 'query' => [], @@ -7072,8 +6849,7 @@ public function updateNexus($companyId, $id, $model) * @param int $id The id of the notification you wish to mark as dismissed. * @return NotificationModel */ - public function dismissNotification($id) - { + public function dismissNotification($id) { $path = "/api/v2/notifications/{$id}/dismiss"; $guzzleParams = [ 'query' => [], @@ -7102,8 +6878,7 @@ public function dismissNotification($id) * @param int $id The id of the notification to retrieve. * @return NotificationModel */ - public function getNotification($id) - { + public function getNotification($id) { $path = "/api/v2/notifications/{$id}"; $guzzleParams = [ 'query' => [], @@ -7138,8 +6913,7 @@ public function getNotification($id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listNotifications($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -7176,8 +6950,7 @@ public function listNotifications($filter=null, $top=null, $skip=null, $orderBy= * @param NewAccountRequestModel $model Information about the account you wish to create and the selected product offerings. * @return NewAccountModel */ - public function requestNewAccount($model) - { + public function requestNewAccount($model) { $path = "/api/v2/accounts/request"; $guzzleParams = [ 'query' => [], @@ -7203,8 +6976,7 @@ public function requestNewAccount($model) * @param string $offer The offer to be added to an already existing customer * @return OfferModel */ - public function requestNewEntitlement($id, $offer) - { + public function requestNewEntitlement($id, $offer) { $path = "/api/v2/accounts/{$id}/entitlements/{$offer}"; $guzzleParams = [ 'query' => [], @@ -7230,8 +7002,7 @@ public function requestNewEntitlement($id, $offer) * @param AccountModel $model The account you wish to create. * @return AccountModel[] */ - public function createAccount($model) - { + public function createAccount($model) { $path = "/api/v2/accounts"; $guzzleParams = [ 'query' => [], @@ -7266,8 +7037,7 @@ public function createAccount($model) * @param NotificationModel[] $model The notifications you wish to create. * @return NotificationModel[] */ - public function createNotifications($model) - { + public function createNotifications($model) { $path = "/api/v2/notifications"; $guzzleParams = [ 'query' => [], @@ -7294,8 +7064,7 @@ public function createNotifications($model) * @param SubscriptionModel[] $model The subscription you wish to create. * @return SubscriptionModel[] */ - public function createSubscriptions($accountId, $model) - { + public function createSubscriptions($accountId, $model) { $path = "/api/v2/accounts/{$accountId}/subscriptions"; $guzzleParams = [ 'query' => [], @@ -7321,8 +7090,7 @@ public function createSubscriptions($accountId, $model) * @param int $id The ID of the account you wish to delete. * @return ErrorDetail[] */ - public function deleteAccount($id) - { + public function deleteAccount($id) { $path = "/api/v2/accounts/{$id}"; $guzzleParams = [ 'query' => [], @@ -7354,8 +7122,7 @@ public function deleteAccount($id) * @param int $id The id of the notification you wish to delete. * @return ErrorDetail[] */ - public function deleteNotification($id) - { + public function deleteNotification($id) { $path = "/api/v2/notifications/{$id}"; $guzzleParams = [ 'query' => [], @@ -7381,8 +7148,7 @@ public function deleteNotification($id) * @param int $id The ID of the subscription you wish to delete. * @return ErrorDetail[] */ - public function deleteSubscription($accountId, $id) - { + public function deleteSubscription($accountId, $id) { $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; $guzzleParams = [ 'query' => [], @@ -7412,8 +7178,7 @@ public function deleteSubscription($accountId, $id) * @param SetPasswordModel $model The new password for this user * @return string */ - public function resetPassword($userId, $unmigrateFromAi, $model) - { + public function resetPassword($userId, $unmigrateFromAi, $model) { $path = "/api/v2/passwords/{$userId}/reset"; $guzzleParams = [ 'query' => ['unmigrateFromAi' => $unmigrateFromAi], @@ -7439,8 +7204,7 @@ public function resetPassword($userId, $unmigrateFromAi, $model) * @param AccountModel $model The account object you wish to update. * @return AccountModel */ - public function updateAccount($id, $model) - { + public function updateAccount($id, $model) { $path = "/api/v2/accounts/{$id}"; $guzzleParams = [ 'query' => [], @@ -7473,8 +7237,7 @@ public function updateAccount($id, $model) * @param NotificationModel $model The notification object you wish to update. * @return NotificationModel */ - public function updateNotification($id, $model) - { + public function updateNotification($id, $model) { $path = "/api/v2/notifications/{$id}"; $guzzleParams = [ 'query' => [], @@ -7505,8 +7268,7 @@ public function updateNotification($id, $model) * @param SubscriptionModel $model The subscription you wish to update. * @return SubscriptionModel */ - public function updateSubscription($accountId, $id, $model) - { + public function updateSubscription($accountId, $id, $model) { $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; $guzzleParams = [ 'query' => [], @@ -7541,8 +7303,7 @@ public function updateSubscription($accountId, $id, $model) * @param int $id The unique ID number of this report * @return object */ - public function downloadReport($id) - { + public function downloadReport($id) { $path = "/api/v2/reports/{$id}/attachment"; $guzzleParams = [ 'query' => [], @@ -7570,8 +7331,7 @@ public function downloadReport($id) * @param int $id The unique ID number of the report to retrieve * @return ReportModel */ - public function getReport($id) - { + public function getReport($id) { $path = "/api/v2/reports/{$id}"; $guzzleParams = [ 'query' => [], @@ -7604,8 +7364,7 @@ public function getReport($id) * @param ExportDocumentLineModel $model Options that may be configured to customize the report. * @return ReportModel[] */ - public function initiateExportDocumentLineReport($companyId, $model) - { + public function initiateExportDocumentLineReport($companyId, $model) { $path = "/api/v2/companies/{$companyId}/reports/exportdocumentline/initiate"; $guzzleParams = [ 'query' => [], @@ -7640,8 +7399,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 FetchResult */ - public function listReports($companyId, $pageKey, $skip=null, $top=null) - { + public function listReports($companyId, $pageKey, $skip=null, $top=null) { $path = "/api/v2/reports"; $guzzleParams = [ 'query' => ['companyId' => $companyId, 'pageKey' => $pageKey, '$skip' => $skip, '$top' => $top], @@ -7673,8 +7431,7 @@ public function listReports($companyId, $pageKey, $skip=null, $top=null) * @param SettingModel[] $model The setting you wish to create. * @return SettingModel[] */ - public function createSettings($companyId, $model) - { + public function createSettings($companyId, $model) { $path = "/api/v2/companies/{$companyId}/settings"; $guzzleParams = [ 'query' => [], @@ -7706,8 +7463,7 @@ public function createSettings($companyId, $model) * @param int $id The ID of the setting you wish to delete. * @return ErrorDetail[] */ - public function deleteSetting($companyId, $id) - { + public function deleteSetting($companyId, $id) { $path = "/api/v2/companies/{$companyId}/settings/{$id}"; $guzzleParams = [ 'query' => [], @@ -7739,8 +7495,7 @@ public function deleteSetting($companyId, $id) * @param int $id The primary key of this setting * @return SettingModel */ - public function getSetting($companyId, $id) - { + public function getSetting($companyId, $id) { $path = "/api/v2/companies/{$companyId}/settings/{$id}"; $guzzleParams = [ 'query' => [], @@ -7779,8 +7534,7 @@ public function getSetting($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listSettingsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -7818,8 +7572,7 @@ public function listSettingsByCompany($companyId, $filter=null, $include=null, $ * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function querySettings($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -7856,8 +7609,7 @@ public function querySettings($filter=null, $include=null, $top=null, $skip=null * @param SettingModel $model The setting you wish to update. * @return SettingModel */ - public function updateSetting($companyId, $id, $model) - { + public function updateSetting($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/settings/{$id}"; $guzzleParams = [ 'query' => [], @@ -7882,8 +7634,7 @@ public function updateSetting($companyId, $id, $model) * @param int $id The primary key of this subscription * @return SubscriptionModel */ - public function getSubscription($accountId, $id) - { + public function getSubscription($accountId, $id) { $path = "/api/v2/accounts/{$accountId}/subscriptions/{$id}"; $guzzleParams = [ 'query' => [], @@ -7914,8 +7665,7 @@ public function getSubscription($accountId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listSubscriptionsByAccount($accountId, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -7945,8 +7695,7 @@ public function listSubscriptionsByAccount($accountId, $filter=null, $top=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function querySubscriptions($filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -7973,8 +7722,7 @@ public function querySubscriptions($filter=null, $top=null, $skip=null, $orderBy * @param TaxCodeModel[] $model The tax code you wish to create. * @return TaxCodeModel[] */ - public function createTaxCodes($companyId, $model) - { + public function createTaxCodes($companyId, $model) { $path = "/api/v2/companies/{$companyId}/taxcodes"; $guzzleParams = [ 'query' => [], @@ -7997,8 +7745,7 @@ public function createTaxCodes($companyId, $model) * @param int $id The ID of the tax code you wish to delete. * @return ErrorDetail[] */ - public function deleteTaxCode($companyId, $id) - { + public function deleteTaxCode($companyId, $id) { $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; $guzzleParams = [ 'query' => [], @@ -8025,8 +7772,7 @@ public function deleteTaxCode($companyId, $id) * @param int $id The primary key of this tax code * @return TaxCodeModel */ - public function getTaxCode($companyId, $id) - { + public function getTaxCode($companyId, $id) { $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; $guzzleParams = [ 'query' => [], @@ -8060,8 +7806,7 @@ public function getTaxCode($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTaxCodesByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -8094,8 +7839,7 @@ public function listTaxCodesByCompany($companyId, $filter=null, $include=null, $ * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryTaxCodes($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -8125,8 +7869,7 @@ public function queryTaxCodes($filter=null, $include=null, $top=null, $skip=null * @param TaxCodeModel $model The tax code you wish to update. * @return TaxCodeModel */ - public function updateTaxCode($companyId, $id, $model) - { + public function updateTaxCode($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/taxcodes/{$id}"; $guzzleParams = [ 'query' => [], @@ -8171,8 +7914,7 @@ public function updateTaxCode($companyId, $id, $model) * @param PointOfSaleDataRequestModel $model Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include. * @return object */ - public function buildTaxContentFile($model) - { + public function buildTaxContentFile($model) { $path = "/api/v2/pointofsaledata/build"; $guzzleParams = [ 'query' => [], @@ -8222,8 +7964,7 @@ public function buildTaxContentFile($model) * @param boolean $includeJurisCodes When true, the file will include jurisdiction codes in the result. * @return object */ - public function buildTaxContentFileForLocation($companyId, $id, $date, $format, $partnerId, $includeJurisCodes) - { + 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' => $includeJurisCodes], @@ -8285,8 +8026,7 @@ public function buildTaxContentFileForLocation($companyId, $id, $date, $format, * @param string $region A two character region code which limits results to a specific region. * @return object */ - public function downloadTaxRatesByZipCode($date, $region) - { + public function downloadTaxRatesByZipCode($date, $region) { $path = "/api/v2/taxratesbyzipcode/download/{$date}"; $guzzleParams = [ 'query' => ['region' => $region], @@ -8321,8 +8061,7 @@ public function downloadTaxRatesByZipCode($date, $region) * @param TaxRuleModel[] $model The tax rule you wish to create. * @return TaxRuleModel[] */ - public function createTaxRules($companyId, $model) - { + public function createTaxRules($companyId, $model) { $path = "/api/v2/companies/{$companyId}/taxrules"; $guzzleParams = [ 'query' => [], @@ -8357,8 +8096,7 @@ public function createTaxRules($companyId, $model) * @param int $id The ID of the tax rule you wish to delete. * @return ErrorDetail[] */ - public function deleteTaxRule($companyId, $id) - { + public function deleteTaxRule($companyId, $id) { $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; $guzzleParams = [ 'query' => [], @@ -8393,8 +8131,7 @@ public function deleteTaxRule($companyId, $id) * @param int $id The primary key of this tax rule * @return TaxRuleModel */ - public function getTaxRule($companyId, $id) - { + public function getTaxRule($companyId, $id) { $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; $guzzleParams = [ 'query' => [], @@ -8436,8 +8173,7 @@ public function getTaxRule($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTaxRules($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -8478,8 +8214,7 @@ public function listTaxRules($companyId, $filter=null, $include=null, $top=null, * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryTaxRules($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -8515,8 +8250,7 @@ public function queryTaxRules($filter=null, $include=null, $top=null, $skip=null * @param TaxRuleModel $model The tax rule you wish to update. * @return TaxRuleModel */ - public function updateTaxRule($companyId, $id, $model) - { + public function updateTaxRule($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/taxrules/{$id}"; $guzzleParams = [ 'query' => [], @@ -8559,8 +8293,7 @@ public function updateTaxRule($companyId, $id, $model) * @param AddTransactionLineModel $model information about the transaction and lines to be added * @return TransactionModel */ - public function addLines($include=null, $model) - { + public function addLines($include=null, $model) { $path = "/api/v2/companies/transactions/lines/add"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -8615,8 +8348,7 @@ public function addLines($include=null, $model) * @param AdjustTransactionModel $model The adjustment you wish to make * @return TransactionModel */ - public function adjustTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) - { + public function adjustTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/adjust"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -8662,8 +8394,7 @@ public function adjustTransaction($companyCode, $transactionCode, $documentType, * @param string $transactionCode The code identifying the transaction * @return AuditTransactionModel */ - public function auditTransaction($companyCode, $transactionCode) - { + public function auditTransaction($companyCode, $transactionCode) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/audit"; $guzzleParams = [ 'query' => [], @@ -8710,8 +8441,7 @@ public function auditTransaction($companyCode, $transactionCode) * @param string $documentType The document type of the original transaction (See DocumentType::* for a list of allowable values) * @return AuditTransactionModel */ - public function auditTransactionWithType($companyCode, $transactionCode, $documentType) - { + public function auditTransactionWithType($companyCode, $transactionCode, $documentType) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/types/{$documentType}/audit"; $guzzleParams = [ 'query' => [], @@ -8740,8 +8470,7 @@ public function auditTransactionWithType($companyCode, $transactionCode, $docume * @param BulkLockTransactionModel $model bulk lock request * @return BulkLockTransactionResult */ - public function bulkLockTransaction($model) - { + public function bulkLockTransaction($model) { $path = "/api/v2/transactions/lock"; $guzzleParams = [ 'query' => [], @@ -8796,8 +8525,7 @@ public function bulkLockTransaction($model) * @param ChangeTransactionCodeModel $model The code change request you wish to execute * @return TransactionModel */ - public function changeTransactionCode($companyCode, $transactionCode, $documentType, $include=null, $model) - { + public function changeTransactionCode($companyCode, $transactionCode, $documentType, $include=null, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/changecode"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -8850,8 +8578,7 @@ public function changeTransactionCode($companyCode, $transactionCode, $documentT * @param CommitTransactionModel $model The commit request you wish to execute * @return TransactionModel */ - public function commitTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) - { + public function commitTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/commit"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -8907,8 +8634,7 @@ public function commitTransaction($companyCode, $transactionCode, $documentType, * @param CreateOrAdjustTransactionModel $model The transaction you wish to create or adjust * @return TransactionModel */ - public function createOrAdjustTransaction($include=null, $model) - { + public function createOrAdjustTransaction($include=null, $model) { $path = "/api/v2/transactions/createoradjust"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -8971,8 +8697,7 @@ public function createOrAdjustTransaction($include=null, $model) * @param CreateTransactionModel $model The transaction you wish to create * @return TransactionModel */ - public function createTransaction($include=null, $model) - { + public function createTransaction($include=null, $model) { $path = "/api/v2/transactions/create"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -9012,8 +8737,7 @@ public function createTransaction($include=null, $model) * @param RemoveTransactionLineModel $model information about the transaction and lines to be removed * @return TransactionModel */ - public function deleteLines($include=null, $model) - { + public function deleteLines($include=null, $model) { $path = "/api/v2/companies/transactions/lines/delete"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -9064,8 +8788,7 @@ public function deleteLines($include=null, $model) * @param string $include Specifies objects to include in this fetch call * @return TransactionModel */ - public function getTransactionByCode($companyCode, $transactionCode, $documentType, $include=null) - { + public function getTransactionByCode($companyCode, $transactionCode, $documentType, $include=null) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -9099,8 +8822,7 @@ public function getTransactionByCode($companyCode, $transactionCode, $documentTy * @param string $include Specifies objects to include in this fetch call * @return TransactionModel */ - public function getTransactionByCodeAndType($companyCode, $transactionCode, $documentType, $include=null) - { + public function getTransactionByCodeAndType($companyCode, $transactionCode, $documentType, $include=null) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/types/{$documentType}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -9140,8 +8862,7 @@ public function getTransactionByCodeAndType($companyCode, $transactionCode, $doc * @param string $include Specifies objects to include in this fetch call * @return TransactionModel */ - public function getTransactionById($id, $include=null) - { + public function getTransactionById($id, $include=null) { $path = "/api/v2/transactions/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -9198,8 +8919,7 @@ public function getTransactionById($id, $include=null) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listTransactionsByCompany($companyCode, $dataSourceId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -9254,8 +8974,7 @@ public function listTransactionsByCompany($companyCode, $dataSourceId, $include= * @param LockTransactionModel $model The lock request you wish to execute * @return TransactionModel */ - public function lockTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) - { + public function lockTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/lock"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -9321,8 +9040,7 @@ public function lockTransaction($companyCode, $transactionCode, $documentType, $ * @param RefundTransactionModel $model Information about the refund to create * @return TransactionModel */ - public function refundTransaction($companyCode, $transactionCode, $include=null, $documentType, $useTaxDateOverride, $model) - { + public function refundTransaction($companyCode, $transactionCode, $include=null, $documentType, $useTaxDateOverride, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/refund"; $guzzleParams = [ 'query' => ['$include' => $include, 'documentType' => $documentType, 'useTaxDateOverride' => $useTaxDateOverride], @@ -9375,8 +9093,7 @@ public function refundTransaction($companyCode, $transactionCode, $include=null, * @param SettleTransactionModel $model The data from an external system to reconcile against AvaTax * @return TransactionModel */ - public function settleTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) - { + public function settleTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/settle"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -9423,8 +9140,7 @@ public function settleTransaction($companyCode, $transactionCode, $documentType, * @param string $include Specifies objects to include in this fetch call * @return TransactionModel */ - public function uncommitTransaction($companyCode, $transactionCode, $documentType, $include=null) - { + public function uncommitTransaction($companyCode, $transactionCode, $documentType, $include=null) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/uncommit"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -9468,8 +9184,7 @@ public function uncommitTransaction($companyCode, $transactionCode, $documentTyp * @param string $include Specifies objects to include in this fetch call * @return TransactionModel */ - public function unvoidTransaction($companyCode, $transactionCode, $documentType, $include=null) - { + public function unvoidTransaction($companyCode, $transactionCode, $documentType, $include=null) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/unvoid"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -9521,8 +9236,7 @@ public function unvoidTransaction($companyCode, $transactionCode, $documentType, * @param VerifyTransactionModel $model The data from an external system to reconcile against AvaTax * @return TransactionModel */ - public function verifyTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) - { + public function verifyTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/verify"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -9576,8 +9290,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 TransactionModel */ - public function voidTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) - { + public function voidTransaction($companyCode, $transactionCode, $documentType, $include=null, $model) { $path = "/api/v2/companies/{$companyCode}/transactions/{$transactionCode}/void"; $guzzleParams = [ 'query' => ['documentType' => $documentType, '$include' => $include], @@ -9602,8 +9315,7 @@ public function voidTransaction($companyCode, $transactionCode, $documentType, $ * @param UPCModel[] $model The UPC you wish to create. * @return UPCModel[] */ - public function createUPCs($companyId, $model) - { + public function createUPCs($companyId, $model) { $path = "/api/v2/companies/{$companyId}/upcs"; $guzzleParams = [ 'query' => [], @@ -9627,8 +9339,7 @@ public function createUPCs($companyId, $model) * @param int $id The ID of the UPC you wish to delete. * @return ErrorDetail[] */ - public function deleteUPC($companyId, $id) - { + public function deleteUPC($companyId, $id) { $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; $guzzleParams = [ 'query' => [], @@ -9653,8 +9364,7 @@ public function deleteUPC($companyId, $id) * @param int $id The primary key of this UPC * @return UPCModel */ - public function getUPC($companyId, $id) - { + public function getUPC($companyId, $id) { $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; $guzzleParams = [ 'query' => [], @@ -9686,8 +9396,7 @@ public function getUPC($companyId, $id) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listUPCsByCompany($companyId, $filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -9718,8 +9427,7 @@ public function listUPCsByCompany($companyId, $filter=null, $include=null, $top= * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryUPCs($filter=null, $include=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -9747,8 +9455,7 @@ public function queryUPCs($filter=null, $include=null, $top=null, $skip=null, $o * @param UPCModel $model The UPC you wish to update. * @return UPCModel */ - public function updateUPC($companyId, $id, $model) - { + public function updateUPC($companyId, $id, $model) { $path = "/api/v2/companies/{$companyId}/upcs/{$id}"; $guzzleParams = [ 'query' => [], @@ -9776,8 +9483,7 @@ public function updateUPC($companyId, $id, $model) * @param PasswordChangeModel $model An object containing your current password and the new password. * @return string */ - public function changePassword($model) - { + public function changePassword($model) { $path = "/api/v2/passwords"; $guzzleParams = [ 'query' => [], @@ -9808,8 +9514,7 @@ public function changePassword($model) * @param UserModel[] $model The user or array of users you wish to create. * @return UserModel[] */ - public function createUsers($accountId, $model) - { + public function createUsers($accountId, $model) { $path = "/api/v2/accounts/{$accountId}/users"; $guzzleParams = [ 'query' => [], @@ -9837,8 +9542,7 @@ public function createUsers($accountId, $model) * @param int $accountId The accountID of the user you wish to delete. * @return ErrorDetail[] */ - public function deleteUser($id, $accountId) - { + public function deleteUser($id, $accountId) { $path = "/api/v2/accounts/{$accountId}/users/{$id}"; $guzzleParams = [ 'query' => [], @@ -9867,8 +9571,7 @@ public function deleteUser($id, $accountId) * @param string $include Optional fetch commands. * @return UserModel */ - public function getUser($id, $accountId, $include=null) - { + public function getUser($id, $accountId, $include=null) { $path = "/api/v2/accounts/{$accountId}/users/{$id}"; $guzzleParams = [ 'query' => ['$include' => $include], @@ -9905,8 +9608,7 @@ public function getUser($id, $accountId, $include=null) * @param int $accountId The accountID of the user you wish to get. * @return UserEntitlementModel */ - public function getUserEntitlements($id, $accountId) - { + public function getUserEntitlements($id, $accountId) { $path = "/api/v2/accounts/{$accountId}/users/{$id}/entitlements"; $guzzleParams = [ 'query' => [], @@ -9944,8 +9646,7 @@ public function getUserEntitlements($id, $accountId) * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function listUsersByAccount($accountId, $include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -9984,8 +9685,7 @@ public function listUsersByAccount($accountId, $include=null, $filter=null, $top * @param string $orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`. * @return FetchResult */ - public function queryUsers($include=null, $filter=null, $top=null, $skip=null, $orderBy=null) - { + 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], @@ -10012,8 +9712,7 @@ public function queryUsers($include=null, $filter=null, $top=null, $skip=null, $ * @param UserModel $model The user object you wish to update. * @return UserModel */ - public function updateUser($id, $accountId, $model) - { + public function updateUser($id, $accountId, $model) { $path = "/api/v2/accounts/{$accountId}/users/{$id}"; $guzzleParams = [ 'query' => [], @@ -10038,8 +9737,7 @@ public function updateUser($id, $accountId, $model) * @param string $serviceTypeId The service to check * @return SubscriptionModel */ - public function getMySubscription($serviceTypeId) - { + public function getMySubscription($serviceTypeId) { $path = "/api/v2/utilities/subscriptions/{$serviceTypeId}"; $guzzleParams = [ 'query' => [], @@ -10063,8 +9761,7 @@ public function getMySubscription($serviceTypeId) * * @return FetchResult */ - public function listMySubscriptions() - { + public function listMySubscriptions() { $path = "/api/v2/utilities/subscriptions"; $guzzleParams = [ 'query' => [], @@ -10100,8 +9797,7 @@ public function listMySubscriptions() * * @return PingResultModel */ - public function ping() - { + public function ping() { $path = "/api/v2/utilities/ping"; $guzzleParams = [ 'query' => [], diff --git a/src/Models.php b/src/Models.php index a47f924..fdfdb30 100644 --- a/src/Models.php +++ b/src/Models.php @@ -19,685 +19,543 @@ */ class AccountModel { - /** * @var int The unique ID number assigned to this account. */ public $id; - /** * @var string For system registrar use only. */ public $crmid; - /** * @var string The name of this account. */ public $name; - /** * @var string The earliest date on which this account may be used. */ public $effectiveDate; - /** * @var string If this account has been closed, this is the last date the account was open. */ public $endDate; - /** * @var string The current status of this account. (See AccountStatusId::* for a list of allowable values) */ public $accountStatusId; - /** * @var string The type of this account. (See AccountTypeId::* for a list of allowable values) */ public $accountTypeId; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var SubscriptionModel[] Optional: A list of subscriptions granted to this account. To fetch this list, add the query string "?$include=Subscriptions" to your URL. */ public $subscriptions; - /** * @var UserModel[] Optional: A list of all the users belonging to this account. To fetch this list, add the query string "?$include=Users" to your URL. */ public $users; - } - /** * Represents a service that this account has subscribed to. */ class SubscriptionModel { - /** * @var int The unique ID number of this subscription. */ public $id; - /** * @var int The unique ID number of the account this subscription belongs to. */ public $accountId; - /** * @var int The unique ID number of the service that the account is subscribed to. If this is provided, subscription description is ignored. */ public $subscriptionTypeId; - /** * @var string A friendly description of the service that the account is subscribed to. You can either provide the subscription type Id or this but not both. If subscription type Id is provided, then this information is ignored and this field will be updated with the information from subscription type id. */ public $subscriptionDescription; - /** * @var string The date when the subscription began. */ public $effectiveDate; - /** * @var string If the subscription has ended or will end, this date indicates when the subscription ends. */ public $endDate; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * An account user who is permitted to use AvaTax. */ class UserModel { - /** * @var int The unique ID number of this user. */ public $id; - /** * @var int The unique ID number of the account to which this user belongs. */ public $accountId; - /** * @var int If this user is locked to one company (and its children), this is the unique ID number of the company to which this user belongs. */ public $companyId; - /** * @var string The username which is used to log on to the AvaTax website, or to authenticate against API calls. */ public $userName; - /** * @var string The first or given name of the user. */ public $firstName; - /** * @var string The last or family name of the user. */ public $lastName; - /** * @var string The email address to be used to contact this user. If the user has forgotten a password, an email can be sent to this email address with information on how to reset this password. */ public $email; - /** * @var string The postal code in which this user resides. */ public $postalCode; - /** * @var string The security level for this user. (See SecurityRoleId::* for a list of allowable values) */ public $securityRoleId; - /** * @var string The status of the user's password. For a new user created, this is always going to be `UserMustChange` (See PasswordStatusId::* for a list of allowable values) */ public $passwordStatus; - /** * @var boolean True if this user is currently active. */ public $isActive; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - } - /** * Message object */ class ErrorDetail { - /** * @var string Name of the error or message. (See ErrorCodeId::* for a list of allowable values) */ public $code; - /** * @var int Unique ID number referring to this error or message. */ public $number; - /** * @var string Concise summary of the message, suitable for display in the caption of an alert box. */ public $message; - /** * @var string A more detailed description of the problem referenced by this error message, suitable for display in the contents area of an alert box. */ public $description; - /** * @var string Indicates the SOAP Fault code, if this was related to an error that corresponded to AvaTax SOAP v1 behavior. */ public $faultCode; - /** * @var string If this is an error from a downstream system (such as Calc) faultSubCode can be used to represent the fault code from that system. */ public $faultSubCode; - /** * @var string URL to help for this message */ public $helpLink; - /** * @var string Item the message refers to, if applicable. This is used to indicate a missing or incorrect value. */ public $refersTo; - /** * @var string Severity of the message (See SeverityLevel::* for a list of allowable values) */ public $severity; - } - /** * Represents a request for a new account with Avalara for a new subscriber. * Contains information about the account requested and the rate plan selected. */ class NewAccountRequestModel { - /** * @var string The offer code provided to you by your Avalara business development contact. This code controls what services and rates the customer will be provisioned with upon creation. If you do not know your offer code, please contact your Avalara business development representative. */ public $offer; - /** * @var string The id associated with the connector */ public $connectorId; - /** * @var string If your Avalara business development representative requests, please provide the campaign ID associated with your signup process. This campaign identifier helps Avalara match users to the context in which they learned about the product to help improve the accuracy of our messaging. The `campaign` field must be either null or a value provided to you by an Avalara business development representative. If you provide an unexpected value in this field, your API call will fail. */ public $campaign; - /** * @var string If your Avalara business development representative requests, please provide the lead source value associated with your signup process. This lead source identifier helps Avalara match users to the context in which they learned about the product to help improve the accuracy of our messaging. The `leadSource` field must be either null or a value provided to you by an Avalara business development representative. If you provide an unexpected value in this field, your API call will fail. */ public $leadSource; - /** * @var string The date on which the account should take effect. If null, defaults to today. You should leave this value `null` unless specifically requested by your Avalara business development manager. */ public $effectiveDate; - /** * @var string The date on which the account should expire. You should leave this value `null` unless specifically requested by your Avalara business development manager. */ public $endDate; - /** * @var string The name of the account to create */ public $accountName; - /** * @var string Website of the new customer whose account is being created. It is strongly recommended to provide the customer's website URL, as this will help our support representatives better assist customers. */ public $website; - /** * @var string Payment Method to be associated with the account. This is strictly to be used internally unless your Avalara business development manager specifically asks you to provide this value while attempting to create an account. */ public $paymentMethodId; - /** * @var string First name of the primary contact person for this account */ public $firstName; - /** * @var string Last name of the primary contact person for this account */ public $lastName; - /** * @var string Title of the primary contact person for this account */ public $title; - /** * @var string Phone number of the primary contact person for this account */ public $phoneNumber; - /** * @var string Email of the primary contact person for this account */ public $email; - /** * @var string If instructed by your Avalara business development manager, set this value to a temporary password to permit the user to continue their onboarding process. If this value is null, a temporary password is generated by the system and emailed to the user. The user will then be asked to choose a permanent password when they first log on to the AvaTax website. */ public $userPassword; - /** * @var string This option controls what type of a welcome email is sent when the account is created. * `Normal` - A standard welcome email will be sent. * `Suppressed` - No email will be sent. * `Custom` - If your Avalara business development representative provides you with a customized welcome email for your customers, please select this option. */ public $welcomeEmail; - /** * @var CompanyAddress Address information of the account being created. */ public $companyAddress; - /** * @var string Company code to be assigned to the company created for this account. If no company code is provided, this will be defaulted to "DEFAULT" company code. */ public $companyCode; - /** * @var string[] Properties of the primary contact person for this account */ public $properties; - /** * @var boolean Set this to true if and only if the owner of the newly created account accepts Avalara's terms and conditions for your account. Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key. */ public $acceptAvalaraTermsAndConditions; - /** * @var boolean Set this to true if and only if the owner of the newly created account has fully read Avalara's terms and conditions for your account. Reading and accepting Avalara's terms and conditions is necessary in order for the account to receive a license key. */ public $haveReadAvalaraTermsAndConditions; - /** * @var object A dynamic key-value pair for the marketing context information */ public $marketingContext; - /** * @var string Type of the account to be created. Regular, Firm or FirmClient (See AccountTypeId::* for a list of allowable values) */ public $accountType; - /** * @var string United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional. */ public $taxPayerIdNumber; - } - /** * Company Address Information */ class CompanyAddress { - /** * @var string Address Line1 */ public $line; - /** * @var string City */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string 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`. */ public $country; - /** * @var string Postal Code */ public $postalCode; - } - /** * Represents information about a newly created account */ class NewAccountModel { - /** * @var int This is the ID number of the account that was created */ public $accountId; - /** * @var string This is the email address to which credentials were mailed */ public $accountDetailsEmailedTo; - /** * @var string The date and time when this account was created */ public $createdDate; - /** * @var string The date and time when account information was emailed to the user */ public $emailedDate; - /** * @var string If this account includes any limitations, specify them here */ public $limitations; - /** * @var string The license key of the account that was created */ public $licenseKey; - /** * @var string The payment url where the payment method can be set up */ public $paymentUrl; - } - /** * Gets the response for the offer request */ class OfferModel { - /** * @var string Id of the transaction */ public $id; - /** * @var string Message indicating what action took place */ public $offerMessage; - } - /** * Represents a request for a free trial account for AvaTax. * Free trial accounts are only available on the Sandbox environment. */ class FreeTrialRequestModel { - /** * @var string The first or given name of the user requesting a free trial. */ public $firstName; - /** * @var string The last or family name of the user requesting a free trial. */ public $lastName; - /** * @var string The email address of the user requesting a free trial. */ public $email; - /** * @var string The company or organizational name for this free trial. If this account is for personal use, it is acceptable to use your full name here. */ public $company; - /** * @var string The phone number of the person requesting the free trial. */ public $phone; - /** * @var string Campaign identifier for Notification purpose */ public $campaign; - /** * @var CompanyAddress The Address information of the account */ public $companyAddress; - /** * @var string Website of the company or user requesting a free trial */ public $website; - /** * @var boolean Read Avalara's terms and conditions is necessary for a free trial account */ public $haveReadAvalaraTermsAndConditions; - /** * @var boolean Accept Avalara's terms and conditions is necessary for a free trial */ public $acceptAvalaraTermsAndConditions; - } - /** * Represents a license key reset request. */ class ResetLicenseKeyModel { - /** * @var int The primary key of the account ID to reset */ public $accountId; - /** * @var boolean Set this value to true to reset the license key for this account. This license key reset function will only work when called using the credentials of the account administrator of this account. */ public $confirmResetLicenseKey; - } - /** * Represents a license key for this account. */ class LicenseKeyModel { - /** * @var int The primary key of the account */ public $accountId; - /** * @var string This is your private license key. You must record this license key for safekeeping. If you lose this key, you must contact the ResetLicenseKey API in order to request a new one. Each account can only have one license key at a time. */ public $privateLicenseKey; - /** * @var string If your software allows you to specify the HTTP Authorization header directly, this is the header string you should use when contacting Avalara to make API calls with this license key. */ public $httpRequestHeader; - } - /** * An account user who is permitted to use AvaTax. */ class AccountLicenseKeyModel { - /** * @var string The unique name for license key per account */ public $name; - /** * @var int AccountId for required license key */ public $accountId; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The user id for the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user id of user who last modified this record. */ public $modifiedUserId; - } - /** * Represents a request to activate an account by reading and accepting its terms and conditions. */ class ActivateAccountModel { - /** * @var boolean Set this to true if and only if you accept Avalara's terms and conditions for your account. */ public $acceptAvalaraTermsAndConditions; - /** * @var boolean Set this to true if and only if you have fully read Avalara's terms and conditions for your account. */ public $haveReadAvalaraTermsAndConditions; - } - /** * Represents one configuration setting for this account */ class AccountConfigurationModel { - /** * @var int The unique ID number of the account to which this setting applies */ public $accountId; - /** * @var string The category of the configuration setting. Avalara-defined categories include `AddressServiceConfig` and `TaxServiceConfig`. Customer-defined categories begin with `X-`. */ public $category; - /** * @var string The name of the configuration setting */ public $name; - /** * @var string The current value of the configuration setting */ public $value; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Provides detailed information about an API call. * @@ -707,1167 +565,928 @@ class AccountConfigurationModel */ class AuditModel { - /** * @var int A unique ID number referring to this individual API call. */ public $transactionId; - /** * @var int The unique ID number of the account to which the user belongs. */ public $accountId; - /** * @var int The unique ID number of the user that performed this API call. */ public $userId; - /** * @var string The origin IP address from which AvaTax received this API call. If you use a proxy layer or other gateway, this IP address may be the address of the gateway. This information is not guaranteed to be accurate and may change based on network conditions between your site and AvaTax. */ public $ipAddress; - /** * @var string If your API call specified a `MachineName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present. */ public $machineName; - /** * @var string If your API call specified a `ClientName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present. */ public $clientName; - /** * @var string If your API call specified a `ClientVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present. */ public $clientVersion; - /** * @var string If your API call specified a `AdapterName` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present. */ public $adapterName; - /** * @var string If your API call specified a `AdapterVersion` in the [Client Profile Headers](https://developer.avalara.com/avatax/client-headers/), this variable will contain its value. This information is self-reported by the client and is not guaranteed to be present. */ public $adapterVersion; - /** * @var string The server name of the AvaTax server that responded to this API call. */ public $serverName; - /** * @var string The software version number of the currently deployed AvaTax API software on the server that responded to this API call. */ public $serverVersion; - /** * @var int A context-dependent reference ID for this API call. This reference ID is not guaranteed to contain a specific value and may be used differently by various API calls. */ public $referenceId; - /** * @var int If the API contained a specific type of error code, this value would contain the unique ID number of the severity level of the response returned to the client. */ public $severityLevelId; - /** * @var string The server timestamp, in UTC, of the time when the server received this API call. */ public $serverTimestamp; - /** * @var int The number of milliseconds that the AvaTax server took to respond to this API call. */ public $serverDuration; - /** * @var string The service name of the AvaTax API service that responded to this API call. */ public $serviceName; - /** * @var string The operation name of this API call. */ public $operation; - /** * @var string A context-dependent reference code for this API call. This reference code is not guaranteed to contain a specific value and may be used differently by various API calls. */ public $referenceCode; - /** * @var string If this API call reported an error, this contains the name of the error that was returned. You can look up more information about AvaTax error messages on the [AvaTax REST Error Page](https://developer.avalara.com/avatax/errors/). */ public $errorMessage; - /** * @var string Reserved for Avalara internal usage. */ public $auditMessage; - /** * @var int Reserved for Avalara internal usage. */ public $loadBalancerDuration; - /** * @var int If this API call returned an array of information, this value contains the number of records returned. */ public $recordCount; - /** * @var string Reserved for Avalara internal usage. */ public $referenceAuthorization; - /** * @var boolean Reserved for Avalara internal usage. */ public $isQueued; - /** * @var int If this API call included requests made to any of the AvaTax data layers, this contains the number of requests that were traced. Please note that not all data layers support this measurement. */ public $databaseCallCount; - /** * @var string If this API call included requests made to any of the AvaTax data layers, this contains the total duration time measured for all the requests. Please note that not all data layers support this measurement. */ public $databaseCallDuration; - /** * @var string If this API call included interoperation with other Avalara services, this contains the amount of time taken by those services. */ public $remoteCallDuration; - /** * @var AuditEvent[] Reserved for Avalara internal usage. */ public $events; - /** * @var string The original request URL as provided by the client. */ public $requestUrl; - /** * @var string If this request was an HTTP request that included a body such as a POST or a PUT, this will contain the request body sent by the client. This request body is represented as a string, exactly as it was received from the client. Regardless of whether the request was JSON, Base64 encoded bytes, or a CSV file, this contains the exact contents of the request body. */ public $requestBody; - /** * @var int The HTTP response code that was sent by the server. */ public $responseStatus; - /** * @var string The entire response body sent from the AvaTax server to the client. This value is returned as a string regardless of whether the results were JSON-formatted text, CSV files, or raw strings. */ public $responseBody; - /** * @var AuditModel[] Reserved for Avalara internal usage. */ public $remoteCalls; - } - /** * */ class AuditEvent { - /** * @var int */ public $auditEventId; - /** * @var int */ public $transactionId; - /** * @var int */ public $auditEventLevelId; - /** * @var string */ public $eventTimestamp; - /** * @var string */ public $source; - /** * @var string */ public $summary; - /** * @var string */ public $details; - } - /** * TextCase info for input address */ class AddressValidationInfo { - /** * @var string Specify the text case for the validated address result. If not specified, will return uppercase. (See TextCase::* for a list of allowable values) */ public $textCase; - /** * @var string First line of the street address */ public $line1; - /** * @var string Second line of the street address */ public $line2; - /** * @var string Third line of the street address */ public $line3; - /** * @var string City component of the address */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string 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`. */ public $country; - /** * @var string Postal Code / Zip Code component of the address. */ public $postalCode; - /** * @var float Geospatial latitude measurement, in Decimal Degrees floating point format. */ public $latitude; - /** * @var float Geospatial longitude measurement, in Decimal Degrees floating point format. */ public $longitude; - } - /** * Address Resolution Model */ class AddressResolutionModel { - /** * @var AddressInfo The original address */ public $address; - /** * @var ValidatedAddressInfo[] The validated address or addresses */ public $validatedAddresses; - /** * @var CoordinateInfo The geospatial coordinates of this address */ public $coordinates; - /** * @var string The resolution quality of the geospatial coordinates (See ResolutionQuality::* for a list of allowable values) */ public $resolutionQuality; - /** * @var TaxAuthorityInfo[] List of informational and warning messages regarding this address */ public $taxAuthorities; - /** * @var AvaTaxMessage[] List of informational and warning messages regarding this address */ public $messages; - } - /** * Represents a base address element. */ class AddressInfo { - /** * @var string First line of the street address */ public $line1; - /** * @var string Second line of the street address */ public $line2; - /** * @var string Third line of the street address */ public $line3; - /** * @var string City component of the address */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string 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`. */ public $country; - /** * @var string Postal Code / Zip Code component of the address. */ public $postalCode; - /** * @var float Geospatial latitude measurement, in Decimal Degrees floating point format. */ public $latitude; - /** * @var float Geospatial longitude measurement, in Decimal Degrees floating point format. */ public $longitude; - } - /** * Represents a validated address */ class ValidatedAddressInfo { - /** * @var string Address type code. One of: * Firm or company address * General Delivery address * High-rise or business complex * PO Box address * Rural route address * Street or residential address */ public $addressType; - /** * @var string First line of the street address */ public $line1; - /** * @var string Second line of the street address */ public $line2; - /** * @var string Third line of the street address */ public $line3; - /** * @var string City component of the address */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string 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`. */ public $country; - /** * @var string Postal Code / Zip Code component of the address. */ public $postalCode; - /** * @var float Geospatial latitude measurement, in Decimal Degrees floating point format. */ public $latitude; - /** * @var float Geospatial longitude measurement, in Decimal Degrees floating point format. */ public $longitude; - } - /** * Coordinate Info */ class CoordinateInfo { - /** * @var float Latitude */ public $latitude; - /** * @var float Longitude */ public $longitude; - } - /** * Information about a tax authority relevant for an address. */ class TaxAuthorityInfo { - /** * @var string A unique ID number assigned by Avalara to this tax authority. */ public $avalaraId; - /** * @var string The friendly jurisdiction name for this tax authority. */ public $jurisdictionName; - /** * @var string The type of jurisdiction referenced by this tax authority. (See JurisdictionType::* for a list of allowable values) */ public $jurisdictionType; - /** * @var string An Avalara-assigned signature code for this tax authority. */ public $signatureCode; - } - /** * Informational or warning messages returned by AvaTax with a transaction */ class AvaTaxMessage { - /** * @var string A brief summary of what this message tells us */ public $summary; - /** * @var string Detailed information that explains what the summary provided */ public $details; - /** * @var string Information about what object in your request this message refers to */ public $refersTo; - /** * @var string A category that indicates how severely this message affects the results */ public $severity; - /** * @var string The name of the code or service that generated this message */ public $source; - } - /** * Model for Advanced Rules when full details are requested */ class AdvancedRuleFullDetailsModel { - /** * @var string The code script for the rule */ public $script; - /** * @var string Script run for validating customer data */ public $customerDataValidatorScript; - /** * @var boolean Has the rule been approved */ public $isApproved; - /** * @var string Creator of the rule */ public $createdBy; - /** * @var string When the rule was created */ public $createdOn; - /** * @var string Last updater of the rule */ public $modifiedBy; - /** * @var string When the rule was last updated */ public $modifiedOn; - /** * @var string Approver of the rule */ public $approvedBy; - /** * @var boolean Is this a system rule as opposed to customer-facing */ public $isSystemRule; - /** * @var boolean Is the rule displayed in the CUP UI */ public $isVisibleInCUP; - /** * @var boolean Is this a rule created for testing */ public $isTest; - /** * @var string The JSON schema for customer data if it is required for the rule */ public $customerDataSchema; - /** * @var int The version of the rule */ public $version; - /** * @var int[] Account Ids the rule is visible for in CUP, when IsVisibleInCUP = false */ public $accountsVisibleFor; - /** * @var string Unique identifier for a rule */ public $ruleId; - /** * @var string Rule name */ public $name; - /** * @var string Description of the rule */ public $description; - /** * @var boolean Advance Rules limited availability */ public $arEntitlementRequired; - /** * @var string Execution position. Both, Before or After */ public $executionPosition; - } - /** * Model for retrieving customer data schema */ class AdvancedRuleCustomerDataSchemaModel { - /** * @var string Unique identifier for the rule */ public $ruleId; - /** * @var string Customer data schema */ public $customerDataSchema; - } - /** * A company or business entity. */ class CompanyModel { - /** * @var int The unique ID number of this company. */ public $id; - /** * @var int The unique ID number of the account this company belongs to. */ public $accountId; - /** * @var int If this company is fully owned by another company, this is the unique identity of the parent company. */ public $parentCompanyId; - /** * @var string If this company files Streamlined Sales Tax, this is the PID of this company as defined by the Streamlined Sales Tax governing board. */ public $sstPid; - /** * @var string A unique code that references this company within your account. */ public $companyCode; - /** * @var string The name of this company, as shown to customers. */ public $name; - /** * @var boolean This flag is true if this company is the default company for this account. Only one company may be set as the default. */ public $isDefault; - /** * @var int If set, this is the unique ID number of the default location for this company. */ public $defaultLocationId; - /** * @var boolean This flag indicates whether tax activity can occur for this company. Set this flag to true to permit the company to process transactions. */ public $isActive; - /** * @var string For United States companies, this field contains your Taxpayer Identification Number. This is a nine digit number that is usually called an EIN for an Employer Identification Number if this company is a corporation, or SSN for a Social Security Number if this company is a person. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional. */ public $taxpayerIdNumber; - /** * @var boolean Set this field to true if the taxPayerIdNumber is a FEIN. */ public $isFein; - /** * @var boolean Set this flag to true to give this company its own unique tax profile. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent. */ public $hasProfile; - /** * @var boolean Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for the company. */ public $isReportingEntity; - /** * @var string If this company participates in Streamlined Sales Tax, this is the date when the company joined the SST program. */ public $sstEffectiveDate; - /** * @var string The two character ISO-3166 country code of the default country for this company. */ public $defaultCountry; - /** * @var string This is the three character ISO-4217 currency code of the default currency used by this company. */ public $baseCurrencyCode; - /** * @var string Indicates whether this company prefers to round amounts at the document level or line level. (See RoundingLevelId::* for a list of allowable values) */ public $roundingLevelId; - /** * @var boolean Set this value to true to receive warnings in API calls via SOAP. */ public $warningsEnabled; - /** * @var boolean Set this flag to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes. */ public $isTest; - /** * @var string Used to apply tax detail dependency at a jurisdiction level. (See TaxDependencyLevelId::* for a list of allowable values) */ public $taxDependencyLevelId; - /** * @var boolean Set this value to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions. */ public $inProgress; - /** * @var string Business Identification No */ public $businessIdentificationNo; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var ContactModel[] Optional: A list of contacts defined for this company. To fetch this list, add the query string `?$include=Contacts` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $contacts; - /** * @var ItemModel[] Optional: A list of items defined for this company. To fetch this list, add the query string `?$include=Items` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $items; - /** * @var LocationModel[] Optional: A list of locations defined for this company. To fetch this list, add the query string `?$include=Locations` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $locations; - /** * @var NexusModel[] Optional: A list of nexus defined for this company. To fetch this list, add the query string `?$include=Nexus` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $nexus; - /** * @var SettingModel[] Optional: A list of settings defined for this company. To fetch this list, add the query string `?$include=Settings` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $settings; - /** * @var TaxCodeModel[] Optional: A list of tax codes defined for this company. To fetch this list, add the query string `?$include=TaxCodes` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $taxCodes; - /** * @var TaxRuleModel[] Optional: A list of tax rules defined for this company. To fetch this list, add the query string `?$include=TaxRules` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $taxRules; - /** * @var UPCModel[] Optional: A list of UPCs defined for this company. To fetch this list, add the query string `?$include=UPCs` to your URL. When calling `CreateCompany`, you may provide a list of objects in this element and they will be created alongside the company. The `UpdateCompany` API does not permit updating nested objects. */ public $upcs; - /** * @var CompanyModel[] Optional: A list of non reporting child companies associated with this company. To fetch this list, add the query string `?$include=NonReportingChildren` to your URL. */ public $nonReportingChildCompanies; - /** * @var EcmsModel[] DEPRECATED - Date: 9/15/2017, Version: 17.10, Message: Please use the `ListCertificates` API. */ public $exemptCerts; - /** * @var string The unique identifier of the mini-one-stop-shop used for Value Added Tax (VAT) processing. */ public $mossId; - /** * @var string The country code of the mini-one-stop-shop used for Value Added Tax (VAT) processing. */ public $mossCountry; - /** * @var CompanyParameterDetailModel[] The parameters of a company */ public $parameters; - } - /** * A contact person for a company. */ class ContactModel { - /** * @var int The unique ID number of this contact. */ public $id; - /** * @var int The unique ID number of the company to which this contact belongs. */ public $companyId; - /** * @var string A unique code for this contact. */ public $contactCode; - /** * @var string The first or given name of this contact. */ public $firstName; - /** * @var string The middle name of this contact. */ public $middleName; - /** * @var string The last or family name of this contact. */ public $lastName; - /** * @var string Professional title of this contact. */ public $title; - /** * @var string The first line of the postal mailing address of this contact. */ public $line1; - /** * @var string The second line of the postal mailing address of this contact. */ public $line2; - /** * @var string The third line of the postal mailing address of this contact. */ public $line3; - /** * @var string The city of the postal mailing address of this contact. */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string The postal code or zip code of the postal mailing address of this contact. */ public $postalCode; - /** * @var string 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`. */ public $country; - /** * @var string The email address of this contact. */ public $email; - /** * @var string The main phone number for this contact. */ public $phone; - /** * @var string The mobile phone number for this contact. */ public $mobile; - /** * @var string The facsimile phone number for this contact. */ public $fax; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Represents an item in your company's product catalog. */ class ItemModel { - /** * @var int The unique ID number of this item. */ public $id; - /** * @var int The unique ID number of the company that owns this item. */ public $companyId; - /** * @var string A unique code representing this item. */ public $itemCode; - /** * @var int DEPRECATED - Date: 11/13/2018, Version: 18.12, Message: For identifying an `Item` with `Avalara TaxCode`, please call the [CreateItemClassification API] with your ItemCode and the Avalara TaxCode. The unique ID number of the tax code that is applied when selling this item. When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values. */ public $taxCodeId; - /** * @var string DEPRECATED - Date: 11/13/2018, Version: 18.12, Message: For identifying an `Item` with `Avalara TaxCode`, please call the [CreateItemClassification API] with your ItemCode and the Avalara TaxCode. The unique code string of the Tax Code that is applied when selling this item. When creating or updating an item, you can either specify the Tax Code ID number or the Tax Code string; you do not need to specify both values. */ public $taxCode; - /** * @var string A friendly description of this item in your product catalog. */ public $description; - /** * @var string A way to group similar items. */ public $itemGroup; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var ClassificationModel[] List of classifications that belong to this item. A single classification consits of a productCode and a systemCode for a particular item. */ public $classifications; - /** * @var ItemParameterModel[] List of item parameters. */ public $parameters; - } - /** * A location where this company does business. * Some jurisdictions may require you to list all locations where your company does business. */ class LocationModel { - /** * @var int The unique ID number of this location. */ public $id; - /** * @var int The unique ID number of the company that operates at this location. */ public $companyId; - /** * @var string A code that identifies this location. Must be unique within your company. */ public $locationCode; - /** * @var string A friendly name for this location. */ public $description; - /** * @var string Indicates whether this location is a physical place of business or a temporary salesperson location. (See AddressTypeId::* for a list of allowable values) */ public $addressTypeId; - /** * @var string Indicates the type of place of business represented by this location. (See AddressCategoryId::* for a list of allowable values) */ public $addressCategoryId; - /** * @var string The first line of the physical address of this location. */ public $line1; - /** * @var string The second line of the physical address of this location. */ public $line2; - /** * @var string The third line of the physical address of this location. */ public $line3; - /** * @var string The city of the physical address of this location. */ public $city; - /** * @var string The county name of the physical address of this location. Not required. */ public $county; - /** * @var string Name or ISO 3166 code identifying the region within the country of the physical address of this location. 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`. */ public $region; - /** * @var string The postal code or zip code of the physical address of this location. */ public $postalCode; - /** * @var string Name or ISO 3166 code identifying the country of the physical address of this location. 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`. */ public $country; - /** * @var boolean Set this flag to true to indicate that this is the default location for this company. */ public $isDefault; - /** * @var boolean Set this flag to true to indicate that this location has been registered with a tax authority. */ public $isRegistered; - /** * @var string If this location has a different business name from its legal entity name, specify the "Doing Business As" name for this location. */ public $dbaName; - /** * @var string A friendly name for this location. */ public $outletName; - /** * @var string The date when this location was opened for business, or null if not known. */ public $effectiveDate; - /** * @var string If this place of business has closed, the date when this location closed business. */ public $endDate; - /** * @var string The most recent date when a transaction was processed for this location. Set by AvaTax. */ public $lastTransactionDate; - /** * @var string The date when this location was registered with a tax authority. Not required. */ public $registeredDate; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var LocationSettingModel[] Extra information required by certain jurisdictions for filing. For a list of settings recognized by Avalara, query the endpoint "/api/v2/definitions/locationquestions". To determine the list of settings required for this location, query the endpoint "/api/v2/companies/(id)/locations/(id)/validate". */ public $settings; - /** * @var LocationParameterModel[] List of location parameters. */ public $parameters; - } - /** * Represents a declaration of nexus within a particular taxing jurisdiction. * @@ -1884,159 +1503,127 @@ class LocationModel */ class NexusModel { - /** * @var int The unique ID number of this declaration of nexus. This field is defined automatically when you declare nexus. You do not need to provide a value for this field. */ public $id; - /** * @var int The unique ID number of the company that declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object. */ public $companyId; - /** * @var string Name or ISO 3166 code identifying the country in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $country; - /** * @var string Name or ISO 3166 code identifying the region within the country. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $region; - /** * @var string DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead. The jurisdiction type of the jurisdiction in which this company declared nexus. (See JurisTypeId::* for a list of allowable values) */ public $jurisTypeId; - /** * @var string The type of the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. (See JurisdictionType::* for a list of allowable values) */ public $jurisdictionTypeId; - /** * @var string The code identifying the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $jurisCode; - /** * @var string The common name of the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $jurisName; - /** * @var string The date when this nexus began. If not known, set to null. This field is user-selectable and should be provided when creating or updating a nexus object. */ public $effectiveDate; - /** * @var string If this nexus will end or has ended on a specific date, set this to the date when this nexus ends. This field is user-selectable and should be provided when creating or updating a nexus object. */ public $endDate; - /** * @var string The short name of the jurisdiction. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $shortName; - /** * @var string The signature code of the boundary region as defined by Avalara. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $signatureCode; - /** * @var string The state assigned number of this jurisdiction. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $stateAssignedNo; - /** * @var string The type of nexus that this company is declaring. If you are voluntarily declaring nexus in a jurisdiction, you should select `SalesOrSellersUseTax` for your nexus type option. This option allows you to calculate tax correctly whether you are selling in-state or shipping from an out-of-state location. If you are legally obligated to declare nexus due to physical presence or other sufficient nexus, you should select `SalesTax`. This indicates that, as a legal requirement, your company must always collect and remit full sales tax in this jurisdiction. If you are participating in the Streamlined Sales Tax program, your SST administrator will select nexus settings for you in all SST jurisdictions. Do not select any SST options by yourself. This field is user-selectable and should be provided when creating or updating a nexus object. (See NexusTypeId::* for a list of allowable values) */ public $nexusTypeId; - /** * @var string Indicates whether this nexus is defined as origin or destination nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. (See Sourcing::* for a list of allowable values) */ public $sourcing; - /** * @var boolean True if you are also declaring local nexus within this jurisdiction. Many U.S. states have options for declaring nexus in local jurisdictions as well as within the state. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $hasLocalNexus; - /** * @var string If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions. This field is user-selectable and should be provided when creating or updating a nexus object. (See LocalNexusTypeId::* for a list of allowable values) */ public $localNexusTypeId; - /** * @var boolean Set this value to true if your company has a permanent establishment within this jurisdiction. This field is user-selectable and should be provided when creating or updating a nexus object. */ public $hasPermanentEstablishment; - /** * @var string Optional - the tax identification number under which you declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object. */ public $taxId; - /** * @var boolean DEPRECATED - Date: 4/29/2017, Version: 19.4, Message: Please use isSSTActive instead. For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates in the Streamlined Sales Tax program. For countries other than the US, this flag is null. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $streamlinedSalesTax; - /** * @var boolean For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates in the Streamlined Sales Tax program and if the account associated with the Nexus has an active AvaTaxCsp subscription. For countries other than the US, this flag is null. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $isSSTActive; - /** * @var string The date when this record was created. This field is defined automatically when you declare nexus. You do not need to provide a value for this field. */ public $createdDate; - /** * @var int The User ID of the user who created this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. This field is defined automatically when you declare nexus. You do not need to provide a value for this field. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field. */ public $modifiedUserId; - /** * @var string The type of nexus that this company is declaring.Replaces NexusTypeId. Use [ListNexusTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListNexusTaxTypeGroups/) API for a list of nexus tax type groups. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $nexusTaxTypeGroup; - /** * @var int A unique ID number of the tax authority that is associated with this nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. */ public $taxAuthorityId; - /** * @var boolean For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region. Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer of record will then be the company designated to pay taxes marked as being obligated to the importer of record. Set this value to `true` to consider your company as the importer of record and collect these taxes. Leave this value as false or null and taxes will be calculated as if your company is not the importer of record. This value may also be set during each transaction API call. See `CreateTransaction()` for more information. This field is user-selectable and should be provided when creating or updating a nexus object. */ public $isSellerImporterOfRecord; - /** * @var string A description of corresponding tax type applied to the nexus. When a custom nexus is created, it'll have to be matched to a system nexus to be validated successfully. The matched system nexus has a field to describe the tax type applied to it, that field will be copied over to the nexus that is being created. This field is defined by Avalara. Its main purpose is to give a simple description of the tax type associated with the nexus so users have a better understanding of the nexus when it is displayed. */ public $taxName; - /** * @var NexusParameterDetailModel[] List of nexus parameters. */ public $parameters; - } - /** * This object is used to keep track of custom information about a company. * @@ -2051,118 +1638,94 @@ class NexusModel */ class SettingModel { - /** * @var int The unique ID number of this setting. */ public $id; - /** * @var int The unique ID number of the company this setting refers to. */ public $companyId; - /** * @var string A user-defined "set" containing this setting. Avalara defines some sets that cannot be changed. To create your own set, choose a set name that begins with `X-` to indicate that this is an extension value. We recommend that you choose a set name that clearly identifies your application, and then store data within name/value pairs within that set. For example, if you were creating an application called MyApp, you might choose to create a set named `X-MyCompany-MyApp`. */ public $set; - /** * @var string A user-defined "name" for this name-value pair. */ public $name; - /** * @var string The value of this name-value pair. */ public $value; - } - /** * Represents a tax code that can be applied to items on a transaction. * A tax code can have specific rules for specific jurisdictions that change the tax calculation behavior. */ class TaxCodeModel { - /** * @var int The unique ID number of this tax code. */ public $id; - /** * @var int The unique ID number of the company that owns this tax code. */ public $companyId; - /** * @var string A code string that identifies this tax code. */ public $taxCode; - /** * @var string The type of this tax code. */ public $taxCodeTypeId; - /** * @var string A friendly description of this tax code. */ public $description; - /** * @var string If this tax code is a subset of a different tax code, this identifies the parent code. */ public $parentTaxCode; - /** * @var boolean True if this tax code type refers to a physical object. Read only field. */ public $isPhysical; - /** * @var int The Avalara Goods and Service Code represented by this tax code. */ public $goodsServiceCode; - /** * @var string The Avalara Entity Use Code represented by this tax code. */ public $entityUseCode; - /** * @var boolean True if this tax code is active and can be used in transactions. */ public $isActive; - /** * @var boolean True if this tax code has been certified by the Streamlined Sales Tax governing board. By default, you should leave this value empty. */ public $isSSTCertified; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Represents a tax rule that changes the behavior of Avalara's tax engine for certain products and/or entity use codes * in certain jurisdictions. @@ -2176,1485 +1739,1178 @@ class TaxCodeModel */ class TaxRuleModel { - /** * @var int The unique ID number of this tax rule. */ public $id; - /** * @var int The unique ID number of the company that owns this tax rule. */ public $companyId; - /** * @var int For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule. You can choose to specify a tax code either by passing its unique ID number in the `taxCodeId` field or by passing its alphanumeric code in the `taxCode` field. To search for the appropriate tax code for your custom rule, use the `ListTaxCodes` API. The `RateOverrideRule`, `BaseRule`, and `ExemptEntityRule` rule types can be applied to all tax codes. To make a rule that applies to all tax codes, leave both fields blank. The `ProductTaxabilityRule` rule must be associated with a tax code. If you attempt to create a product taxability rule without a tax code, you will get an error message. */ public $taxCodeId; - /** * @var string For rules that apply to a specific tax code only, this specifies which tax code is affected by this rule. You can choose to specify a tax code either by passing its unique ID number in the `taxCodeId` field or by passing its alphanumeric code in the `taxCode` field. To search for the appropriate tax code for your custom rule, use the `ListTaxCodes` API. The `RateOverrideRule`, `BaseRule`, and `ExemptEntityRule` rule types can be applied to all tax codes. To make a rule that applies to all tax codes, leave both fields blank. The `ProductTaxabilityRule` rule must be associated with a tax code. If you attempt to create a product taxability rule without a tax code, you will get an error message. */ public $taxCode; - /** * @var string For U.S. tax rules, this is the state's Federal Information Processing Standard (FIPS) code. This field is required for rules that apply to specific jurisdictions in the United States. It is not required if you set the `isAllJuris` flag to true. */ public $stateFIPS; - /** * @var string The name of the jurisdiction to which this tax rule applies. Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the [ListJurisdictions API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictions/) or the [ListJurisdictionsByAddress API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictionsByAddress/). To set a rule that applies to all jurisdictions of a specific type, see `isAllJuris`. Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the `jurisName`, `jurisCode`, and `jurisdictionTypeId` fields using the information you retrieved from the API above. */ public $jurisName; - /** * @var string The code of the jurisdiction to which this tax rule applies. Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the [ListJurisdictions API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictions/) or the [ListJurisdictionsByAddress API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictionsByAddress/). Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the `jurisName`, `jurisCode`, and `jurisdictionTypeId` fields using the information you retrieved from the API above. */ public $jurisCode; - /** * @var string DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use `jurisdictionTypeId` instead. (See JurisTypeId::* for a list of allowable values) */ public $jurisTypeId; - /** * @var string The type of the jurisdiction to which this tax rule applies. Custom tax rules can apply to a specific jurisdiction or to all jurisdictions. To select a jurisdiction, use the [ListJurisdictions API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictions/) or the [ListJurisdictionsByAddress API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListJurisdictionsByAddress/). Once you have determined which jurisdiction you wish to assign to the tax rule, you should fill in the `jurisName`, `jurisCode`, and `jurisdictionTypeId` fields using the information you retrieved from the API above. To make a custom tax rule for US or Canada that applies to all jurisdictions of a specific type, see the `isAllJuris` field for more information. (See JurisdictionType::* for a list of allowable values) */ public $jurisdictionTypeId; - /** * @var string DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead. */ public $customerUsageType; - /** * @var string The entity use code to which this rule applies. You can create custom `entityUseCode` values with specific behavior using this API, or you can change the behavior of Avalara's system-defined entity use codes. For a full list of Avalara-defined entity use codes, see the [ListEntityUseCodes API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/). */ public $entityUseCode; - /** * @var string Some tax type groups contain multiple different types of tax. To create a rule that affects only one type of tax within a tax type group, set this value to the code matching the specific tax type within that group. The custom tax rule will then only apply to taxes calculated for that specific type. For rules that affect all tax types, use the value `A` to match `All` tax types within that group. (See MatchingTaxType::* for a list of allowable values) */ public $taxTypeId; - /** * @var string DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: Please use `rateTypeCode`, `taxTypeGroup` and `subTaxType` instead. (See RateType::* for a list of allowable values) */ public $rateTypeId; - /** * @var string Indicates the code of the rate type that applies to this rule. Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes. If you specify a value in the rateTypeCode field, this rule will cause tax lines that are affected by the rule to change to a different rate type code. */ public $rateTypeCode; - /** * @var string This type value determines the behavior of the tax rule. You can specify that this rule controls the product's taxability or exempt / nontaxable status, the product's rate (for example, if you have been granted an official ruling for your product's rate that differs from the official rate), or other types of behavior. (See TaxRuleTypeId::* for a list of allowable values) */ public $taxRuleTypeId; - /** * @var boolean Allows you to make tax rules apply to lower jurisdictions. This feature is only available in the United States and Canada. * In the United States, this value can be used for rules written at the `State` jurisdictional level. If set to `true`, this rule will at the state level, county level, city level, and special jurisdiction level. * In Canada, this value can be used for rules written at the `Country` or `State` jurisdictional levels. If set to `true`, this rule will at all lower jurisdictional levels. For any other use case, this value must be `false`. */ public $isAllJuris; - /** * @var float This field has different behavior based on the type of the tax rule. * For a product taxability rule, this value is either 1 or 0, indicating taxable or non-taxable. * For a rate override rule, this value is the corrected rate stored as a decimal, for example, a rate of 5% would be stored as 0.05 decimal. If you use the special value of 1.0, only the cap and threshold values will be applied and the rate will be left alone. */ public $value; - /** * @var float The maximum cap for the price of this item according to this rule. Any amount above this cap will not be subject to this rule. For example, if you must pay 5% of a product's value up to a maximum value of $1000, you would set the `cap` to `1000.00` and the `value` to `0.05`. */ public $cap; - /** * @var float The per-unit threshold that must be met before this rule applies. For example, if your product is nontaxable unless it is above $100 per product, you would set the `threshold` value to `100`. In this case, the rate for the rule would apply to the entire amount above $100. You can also create rules that make the entire product taxable if it exceeds a threshold, but is nontaxable if it is below the threshold. To choose this, set the `options` field to the value `TaxAll`. */ public $threshold; - /** * @var string Supports custom options for your tax rule. Supported options include: * `TaxAll` - This value indicates that the entire amount of the line becomes taxable when the line amount exceeds the `threshold`. */ public $options; - /** * @var string The first date at which this rule applies. If `null`, this rule will apply to all dates prior to the end date. */ public $effectiveDate; - /** * @var string The last date for which this rule applies. If `null`, this rule will apply to all dates after the effective date. */ public $endDate; - /** * @var string A friendly name for this tax rule. */ public $description; - /** * @var string For U.S. tax rules, this is the county's Federal Information Processing Standard (FIPS) code. This field is required for rules that apply to specific jurisdictions in the United States. It is not required if you set the `isAllJuris` flag to true. */ public $countyFIPS; - /** * @var boolean DEPRECATED - Date: 8/27/2018, Version: 18.9, Message: This field is no longer required. */ public $isSTPro; - /** * @var string Name or ISO 3166 code identifying the country where this rule will apply. 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`. */ public $country; - /** * @var string Name or ISO 3166 code identifying the region where this rule will apply. 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`. NOTE: Region is required for US and not required for non-US countries because the user may be either creating a Country-level or Region-level rule. */ public $region; - /** * @var string The sourcing types to which this rule applies. (See Sourcing::* for a list of allowable values) */ public $sourcing; - /** * @var string This field has different behavior based on the type of rule. * For a product taxability rule, if the rule applies to an item, this value will override the tax type group of the original product. * For other rules, this value determines what tax type groups will be affected by the rule. Refer to `ListTaxTypeGroups` for a list of tax type groups supported by AvaTax. */ public $taxTypeGroup; - /** * @var string This field has different behavior based on the type of rule. * For a product taxability rule, if the rule applies to an item, this value will override the tax sub type of the original product. * For other rules, this value determines what tax sub types will be affected by the rule. Refer to `ListTaxSubtypes` for a list of tax sub types supported by AvaTax. */ public $taxSubType; - /** * @var string Reserved for Avalara internal usage. Leave this field null. */ public $nonPassthroughExpression; - /** * @var string The currency code to use for this rule. For a list of currencies supported by AvaTax, use the [ListCurrencies API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCurrencies/). */ public $currencyCode; - /** * @var int Reserved for Avalara internal usage. Leave this field null. */ public $preferredProgramId; - /** * @var int For tax rules that are calculated using units of measurement, this indicates the unit of measurement type used to calculate the amounts for this rule. For a list of units of measurement, use the [ListUnitsOfMeasurement API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListUnitOfMeasurement/). */ public $uomId; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * One Universal Product Code object as defined for your company. */ class UPCModel { - /** * @var int The unique ID number for this UPC. */ public $id; - /** * @var int The unique ID number of the company to which this UPC belongs. */ public $companyId; - /** * @var string The 12-14 character Universal Product Code, European Article Number, or Global Trade Identification Number. */ public $upc; - /** * @var string Legacy Tax Code applied to any product sold with this UPC. */ public $legacyTaxCode; - /** * @var string Description of the product to which this UPC applies. */ public $description; - /** * @var string If this UPC became effective on a certain date, this contains the first date on which the UPC was effective. */ public $effectiveDate; - /** * @var string If this UPC expired or will expire on a certain date, this contains the last date on which the UPC was effective. */ public $endDate; - /** * @var int A usage identifier for this UPC code. */ public $usage; - /** * @var int A flag indicating whether this UPC code is attached to the AvaTax system or to a company. */ public $isSystem; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Exempt certificate */ class EcmsModel { - /** * @var int The calc_id associated with a certificate in CertCapture. */ public $exemptCertId; - /** * @var int Company ID */ public $companyId; - /** * @var string Customer code */ public $customerCode; - /** * @var string Customer name */ public $customerName; - /** * @var string Address line 1 */ public $address1; - /** * @var string Address line 2 */ public $address2; - /** * @var string Address line 3 */ public $address3; - /** * @var string City */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string Postal code / zip code */ public $postalCode; - /** * @var string 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`. */ public $country; - /** * @var string The type of exemption certificate. Permitted values are: Blanket and Single. (See ExemptCertTypeId::* for a list of allowable values) */ public $exemptCertTypeId; - /** * @var string Document Reference Number, in the case of single-use exemption certificates, the DocumentCode or PurchaseOrderNo to which the certificate should apply. */ public $documentRefNo; - /** * @var int Business type the customer belongs to. */ public $businessTypeId; - /** * @var string Other description for this business type */ public $businessTypeOtherDescription; - /** * @var string Exempt reason associated with the certificate, coded by CustomerUsageType. Example: A - Federal Government. */ public $exemptReasonId; - /** * @var string Other description for exempt reason i.e. Populated on if exemptReasonId is 'L' - Other. */ public $exemptReasonOtherDescription; - /** * @var string Effective date for this exempt certificate */ public $effectiveDate; - /** * @var string A list of applicable regions for this exempt certificate. To list more than one applicable region, separate the list of region codes with commas. */ public $regionsApplicable; - /** * @var string Status for this exempt certificate (See ExemptCertStatusId::* for a list of allowable values) */ public $exemptCertStatusId; - /** * @var string Date when this exempt certificate was created */ public $createdDate; - /** * @var string Date when last transaction with this exempt certificate happened */ public $lastTransactionDate; - /** * @var string When this exempt certificate will expire */ public $expiryDate; - /** * @var int User that creates the certificate */ public $createdUserId; - /** * @var string Date when this exempt certificate was modified */ public $modifiedDate; - /** * @var int Who modified this exempt certificate */ public $modifiedUserId; - /** * @var string Name or ISO 3166 code identifying the country that issued this ECMS certificate. 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`. */ public $countryIssued; - /** * @var string If the certificate record was synced from an AvaTax Certs account(as opposed to being entered in ECMS directly), the unique AvaTax Certs identifier for the certificate record. Usually same as the Id of a Certificate. */ public $avaCertId; - /** * @var string Review status for this exempt certificate (See ExemptCertReviewStatusId::* for a list of allowable values) */ public $exemptCertReviewStatusId; - /** * @var EcmsDetailModel[] Exempt Cert details */ public $details; - } - /** * Represents a parameter associated with a company. */ class CompanyParameterDetailModel { - /** * @var int Identifier for company parameter */ public $id; - /** * @var int CompanyId associated with the parameter */ public $companyId; - /** * @var string The parameter's name */ public $name; - /** * @var string The value of the parameter */ public $value; - /** * @var string The unit of measurement code for the parameter */ public $unit; - } - /** * Represents a classification for a given item. */ class ClassificationModel { - /** * @var string The product code of an item in a given system. */ public $productCode; - /** * @var string The system code in which the product belongs. */ public $systemCode; - } - /** * Represents a parameter associated with an item. */ class ItemParameterModel { - /** * @var int The id of the parameter. */ public $id; - /** * @var string The parameter's name. */ public $name; - /** * @var string The value for the parameter. */ public $value; - /** * @var string The unit of measurement code for the parameter. */ public $unit; - /** * @var int The item id */ public $itemId; - } - /** * Represents the answer to one local jurisdiction question for a location. */ class LocationSettingModel { - /** * @var int The unique ID number of the location question answered. */ public $questionId; - /** * @var string The name of the question */ public $questionName; - /** * @var string The answer the user provided. */ public $value; - } - /** * The parameter associated with a company location. */ class LocationParameterModel { - /** * @var int The ID number of the parameter. */ public $id; - /** * @var string The parameter's name. */ public $name; - /** * @var string The parameter's value. */ public $unit; - /** * @var string The value of the parameter. */ public $value; - /** * @var int The ID of the company location the parameter associated with. */ public $locationId; - } - /** * Represents a parameter associated with a nexus. */ class NexusParameterDetailModel { - /** * @var int The id of the parameter. */ public $id; - /** * @var string The parameter's name. */ public $name; - /** * @var string The value for the parameter. */ public $value; - /** * @var string The unit of measurement code for the parameter. */ public $unit; - /** * @var int The nexus id */ public $nexusId; - } - /** * Represents an ECMS record, used internally by AvaTax to track information about exemptions. */ class EcmsDetailModel { - /** * @var int Unique, system-assigned identifier of a ExemptCertDetail record. */ public $exemptCertDetailId; - /** * @var int The calc_id associated with a certificate in CertCapture. */ public $exemptCertId; - /** * @var string State FIPS */ public $stateFips; - /** * @var string 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`. */ public $region; - /** * @var string The customer Tax Id Number (tax_number) associated with a certificate. This is same as exemptionNo in Transactions. */ public $idNo; - /** * @var string 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`. */ public $country; - /** * @var string End date of this exempt certificate */ public $endDate; - /** * @var string The type of idNo (tax_number) associated with a certificate. Example: Driver's Licence Number, Permit Number. */ public $idType; - /** * @var int Is the tax code list an exculsion list? */ public $isTaxCodeListExclusionList; - /** * @var EcmsDetailTaxCodeModel[] optional: list of tax code associated with this exempt certificate detail */ public $taxCodes; - } - /** * */ class EcmsDetailTaxCodeModel { - /** * @var int Id of the exempt certificate detail tax code */ public $exemptCertDetailTaxCodeId; - /** * @var int exempt certificate detail id */ public $exemptCertDetailId; - /** * @var int tax code id */ public $taxCodeId; - } - /** * Model for changing the approved status of an advanced rule */ class ApproveAdvancedRuleModel { - /** * @var boolean Should the rule be approved */ public $isApproved; - } - /** * Model for toggling visibility of an advanced rule for an account */ class AdvancedRuleVisibilityModel { - /** * @var boolean Should the rule be visible or not visible */ public $isVisible; - /** * @var int The account Id for which the rule is to be visible/not visible */ public $accountId; - } - /** * Model representing an execution of an advanced rule for a company */ class AdvancedRuleExecutionModel { - /** * @var string Rule execution unique identifier */ public $ruleExecutionId; - /** * @var string Name of rule execution */ public $name; - /** * @var string Date rule execution starts */ public $startDate; - /** * @var string Date rule execution ends */ public $endDate; - /** * @var boolean Is rule execution enabled */ public $enabled; - /** * @var boolean Should we keep running if we hit an exception */ public $continueOnError; - /** * @var string Unique identifier of rule to execute */ public $ruleId; - /** * @var AdvancedRuleModel Advanced rule to execute */ public $rule; - /** * @var string Json data used for rule execution */ public $customerData; - /** * @var string Unique identifier of customer data used in rule execution */ public $customerDataId; - } - /** * A generic global advanced rule encapsulating a script */ class AdvancedRuleModel { - /** * @var string Unique identifier for a rule */ public $ruleId; - /** * @var string Rule name */ public $name; - /** * @var string Description of the rule */ public $description; - /** * @var boolean Advance Rules limited availability */ public $arEntitlementRequired; - /** * @var string Execution position. Both, Before or After */ public $executionPosition; - } - /** * Model for updating rule execution order */ class AdvancedRuleExecutionOrderModel { - /** * @var string[] The rule execution Ids in the desired order */ public $ruleExecutionIds; - } - /** * Model representing a lookup file for a company */ class AdvancedRuleLookupFileModel { - /** * @var string LookupFile unique identifier */ public $lookupFileId; - /** * @var string CompanyLookupFile unique identifier */ public $id; - /** * @var string Name of lookup file */ public $name; - /** * @var int Content of the lookup file. */ public $content; - /** * @var string File extension (e.g. CSV). */ public $fileExtension; - /** * @var boolean Is this a lookup file created for testing */ public $isTest; - /** * @var boolean Is this a lookup file in use for any rule */ public $inUse; - /** * @var int Lookup file version */ public $version; - /** * @var string Lookup file CreatedOn */ public $createdDate; - /** * @var string Lookup file ModifiedOn */ public $modifiedDate; - } - /** * Represents information about a tax form known to Avalara */ class AvaFileFormModel { - /** * @var int Unique Id of the form */ public $id; - /** * @var string Name of the file being returned */ public $returnName; - /** * @var string Name of the submitted form */ public $formName; - /** * @var string A description of the submitted form */ public $description; - /** * @var string The date this form starts to take effect */ public $effDate; - /** * @var string The date the form finishes to take effect */ public $endDate; - /** * @var string State/Province/Region where the form is submitted for */ public $region; - /** * @var string The country this form is submitted for */ public $country; - /** * @var string The type of the form being submitted (See FormTypeId::* for a list of allowable values) */ public $formTypeId; - /** * @var string The type of Filing option (See FilingOptionTypeId::* for a list of allowable values) */ public $filingOptionTypeId; - /** * @var string The type of the due date (See DueDateTypeId::* for a list of allowable values) */ public $dueDateTypeId; - /** * @var int Due date */ public $dueDay; - /** * @var string The type of E-file due date. (See DueDateTypeId::* for a list of allowable values) */ public $efileDueDateTypeId; - /** * @var int The date by when the E-filing should be submitted */ public $efileDueDay; - /** * @var string The time of day by when the E-filing should be submitted */ public $efileDueTime; - /** * @var boolean Whether the customer has discount */ public $hasVendorDiscount; - /** * @var string The way system does the rounding (See RoundingTypeId::* for a list of allowable values) */ public $roundingTypeId; - /** * @var string The outlet type of the form (See OutletTypeId::* for a list of allowable values) */ public $outletTypeId; - } - /** * Represents a batch of uploaded documents. */ class BatchModel { - /** * @var string The type of this batch. (See BatchType::* for a list of allowable values) */ public $type; - /** * @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 The user-friendly readable name for this batch. */ public $name; - /** * @var int The Account ID number of the account that owns this batch. */ public $accountId; - /** * @var int The Company ID number of the company that owns this batch. */ public $companyId; - /** * @var string This batch's current processing status (See BatchStatus::* for a list of allowable values) */ public $status; - /** * @var string The date/time when this batch started processing */ public $startedDate; - /** * @var int The number of records in this batch; determined by the server */ public $recordCount; - /** * @var int The current record being processed */ public $currentRecord; - /** * @var string The date/time when this batch was completely processed */ public $completedDate; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var BatchFileModel[] The list of files contained in this batch. */ public $files; - } - /** * Represents one file in a batch upload. */ class BatchFileModel { - /** * @var int The unique ID number assigned to this batch file. */ public $id; - /** * @var int The unique ID number of the batch that this file belongs to. */ public $batchId; - /** * @var string Logical Name of file (e.g. "Input" or "Error"). */ public $name; - /** * @var string Content of the batch file. (This value is encoded as a Base64 string) */ public $content; - /** * @var int Size of content, in bytes. */ public $contentLength; - /** * @var string Content mime type (e.g. text/csv). This is used for HTTP downloading. */ public $contentType; - /** * @var string File extension (e.g. CSV). */ public $fileExtension; - /** * @var string Path to the file - name/S3 key */ public $filePath; - /** * @var int Number of errors that occurred when processing this file. */ public $errorCount; - } - /** * Represents a create transaction batch request model. */ class CreateTransactionBatchRequestModel { - /** * @var string The user-friendly readable name for this batch. */ public $name; - /** * @var TransactionBatchItemModel[] The list of transactions contained in this batch. */ public $transactions; - } - /** * Represents a transaction batch item. * Only one child transaction model should contain data. */ class TransactionBatchItemModel { - /** * @var CreateTransactionModel Represents a transaction to be created. */ public $createTransactionModel; - /** * @var BatchAdjustTransactionModel Represents an existing transaction to be adjusted. */ public $adjustTransactionModel; - /** * @var BatchVoidTransactionModel Represents an existing transaction to be voided. */ public $voidTransactionModel; - } - /** * Create a transaction */ class CreateTransactionModel { - /** * @var string The internal reference code used by the client application. This is used for operations such as Get, Adjust, Settle, and Void. If you leave the transaction code blank, a GUID will be assigned to each transaction. */ public $code; - /** * @var LineItemModel[] A list of line items that will appear on this transaction. */ public $lines; - /** * @var string Specifies the type of document to create. A document type ending with `Invoice` is a permanent transaction that will be recorded in AvaTax. A document type ending with `Order` is a temporary estimate that will not be preserved. If you omit this value, the API will assume you want to create a `SalesOrder`. (See DocumentType::* for a list of allowable values) */ public $type; - /** * @var string Company Code - Specify the code of the company creating this transaction here. If you leave this value null, your account's default company will be used instead. */ public $companyCode; - /** * @var string Transaction Date - The date on the invoice, purchase order, etc. By default, this date will be used to calculate the tax rates for the transaction. If you wish to use a different date to calculate tax rates, please specify a `taxOverride` of type `taxDate`. */ public $date; - /** * @var string Salesperson Code - The client application salesperson reference code. */ public $salespersonCode; - /** * @var string Customer Code - The client application customer reference code. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer. */ public $customerCode; - /** * @var string DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. Customer Usage Type - The client application customer or usage type. */ public $customerUsageType; - /** * @var string Entity Use Code - The client application customer or usage type. For a list of available usage types, use [ListEntityUseCodes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/) API. */ public $entityUseCode; - /** * @var float Discount - The discount amount to apply to the document. This value will be applied only to lines that have the `discounted` flag set to true. If no lines have `discounted` set to true, this discount cannot be applied. */ public $discount; - /** * @var string Purchase Order Number for this document. This is required for single use exemption certificates to match the order and invoice with the certificate. */ public $purchaseOrderNo; - /** * @var string Exemption Number for this document. If you specify an exemption number for this document, this document will be considered exempt, and you may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor to verify your exemptions. Note: This is same as 'exemptNo' in TransactionModel. */ public $exemptionNo; - /** * @var AddressesModel Default addresses for all lines in this document. These addresses are the default values that will be used for any lines that do not have their own address information. If you specify addresses for a line, then no default addresses will be loaded for that line. */ public $addresses; - /** * @var TransactionParameterModel[] Special parameters for this transaction. To get a full list of available parameters, please use the [ListParameters](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListParameters/) endpoint. */ public $parameters; - /** * @var string Customer-provided Reference Code with information about this transaction. This field could be used to reference the original document for a return invoice, or for any other reference purpose. */ public $referenceCode; - /** * @var string Sets the sale location code (Outlet ID) for reporting this document to the tax authority. This value is used by Avalara Managed Returns to group documents together by reporting locations for tax authorities that require location-based reporting. */ public $reportingLocationCode; - /** * @var boolean Causes the document to be committed if true. This option is only applicable for invoice document types, not orders. */ public $commit; - /** * @var string BatchCode for batch operations. */ public $batchCode; - /** * @var TaxOverrideModel Specifies a tax override for the entire document */ public $taxOverride; - /** * @var string The three-character ISO 4217 currency code for this transaction. */ public $currencyCode; - /** * @var string Specifies whether the tax calculation is handled Local, Remote, or Automatic (default). This only applies when using an AvaLocal server. (See ServiceMode::* for a list of allowable values) */ public $serviceMode; - /** * @var float Currency exchange rate from this transaction to the company base currency. This only needs to be set if the transaction currency is different than the company base currency. It defaults to 1.0. */ public $exchangeRate; - /** * @var string Effective date of the exchange rate. */ public $exchangeRateEffectiveDate; - /** * @var string Sets the Point of Sale Lane Code sent by the User for this document. */ public $posLaneCode; - /** * @var string VAT business identification number for the customer for this transaction. This number will be used for all lines in the transaction, except for those lines where you have defined a different business identification number. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules. */ public $businessIdentificationNo; - /** * @var boolean Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record. Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer of record will then be the company designated to pay taxes marked as being obligated to the importer of record. Set this value to `true` to consider your company as the importer of record and collect these taxes. This value may also be set at the Nexus level. See `NexusModel` for more information. */ public $isSellerImporterOfRecord; - /** * @var string User-supplied description for this transaction. */ public $description; - /** * @var string User-supplied email address relevant for this transaction. */ public $email; - /** * @var string If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`. (See TaxDebugLevel::* for a list of allowable values) */ public $debugLevel; - } - /** * Replace an existing transaction recorded in AvaTax with a new one. */ class BatchAdjustTransactionModel { - /** * @var string Specifies the code of the company for this transaction. */ public $companyCode; - /** * @var string Please specify the transaction code of the transacion to void. */ public $transactionCode; - /** * @var string Specifies the type of document to void. */ public $documentType; - /** * @var string A reason code indicating why this adjustment was made (See AdjustmentReason::* for a list of allowable values) */ public $adjustmentReason; - /** * @var string If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other). */ public $adjustmentDescription; - /** * @var CreateTransactionModel Replace the current transaction with tax data calculated for this new transaction */ public $newTransaction; - } - /** * A request to void a previously created transaction. */ class BatchVoidTransactionModel { - /** * @var string Company Code - Specify the code of the company for this transaction. */ public $companyCode; - /** * @var string Please specify the transaction code of the transacion to void. */ public $transactionCode; - /** * @var string Specifies the type of document to void. */ public $documentType; - /** * @var string Please specify the reason for voiding or cancelling this transaction. To void the transaction, please specify the reason 'DocVoided'. If you do not provide a reason, the void command will fail. (See VoidReasonCode::* for a list of allowable values) */ public $code; - } - /** * Represents one line item in a transaction */ class LineItemModel { - /** * @var string The line number of this line within the document. This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text. */ public $number; - /** * @var float Quantity of items in this line. This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds. If not provided, or if set to zero, the quantity value is assumed to be one (1). */ public $quantity; - /** * @var float Total amount for this line. The amount represents the net currency value that changed hands from the customer (represented by the `customerCode` field) to the company (represented by the `companyCode`) field. For sale transactions, this value must be positive. It indicates the amount of money paid by the customer to the company. For refund or return transactions, this value must be negative. */ public $amount; - /** * @var AddressesModel The addresses to use for this transaction line. If you set this value to `null`, or if you omit this element from your API call, then instead the transaction will use the `addresses` from the document level. If you specify any other value besides `null`, only addresses specified for this line will be used for this line. */ public $addresses; - /** * @var string Tax Code - System or Custom Tax Code. You can use your own tax code mapping or standard Avalara tax codes. For a full list of tax codes, see `ListTaxCodes`. */ public $taxCode; - /** * @var string DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead. */ public $customerUsageType; - /** * @var string Entity Use Code - The client application customer or usage type. This field allows you to designate a type of usage that may make this transaction considered exempt by reason of exempt usage. For a list of entity use codes, see the Definitions API `ListEntityUseCodes`. */ public $entityUseCode; - /** * @var string Item Code (SKU). If you provide an `itemCode` field, the AvaTax API will look up the item you created with the `CreateItems` API call and use all the information available about that item for this transaction. */ public $itemCode; - /** * @var string The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options. Note: This is same as 'exemptNo' in TransactionModel. */ public $exemptionCode; - /** * @var boolean True if the document discount should be applied to this line. If this value is false, or not provided, discounts will not be applied to this line even if they are specified on the root `discount` element. */ public $discounted; - /** * @var boolean Indicates whether the `amount` for this line already includes tax. If this value is `true`, the final price of this line including tax will equal the value in `amount`. If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line. */ public $taxIncluded; - /** * @var string Revenue Account (Customer Defined Field). This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation. */ public $revenueAccount; - /** * @var string Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation. */ public $ref1; - /** * @var string Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation. */ public $ref2; - /** * @var string Item description. For Streamlined Sales Tax (SST) customers, this field is required if an unmapped `itemCode` is used. */ public $description; - /** * @var string VAT business identification number for the customer for this line item. If you leave this field empty, this line item will use whatever business identification number you provided at the transaction level. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules. */ public $businessIdentificationNo; - /** * @var TaxOverrideModel Specifies a tax override for this line. */ public $taxOverride; - /** * @var TransactionLineParameterModel[] Special parameters that apply to this line within this transaction. To get a full list of available parameters, please use the `ListParameters` API. */ public $parameters; - /** * @var string The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction. For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes. */ public $hsCode; - } - /** * Information about all the addresses involved in this transaction. * @@ -3674,254 +2930,201 @@ class LineItemModel */ class AddressesModel { - /** * @var AddressLocationInfo If this transaction occurred at a retail point-of-sale location, provide that single address here and leave all other address types null. */ public $singleLocation; - /** * @var AddressLocationInfo The origination address where the products were shipped from, or from where the services originated. */ public $shipFrom; - /** * @var AddressLocationInfo The destination address where the products were shipped to, or where the services were delivered. */ public $shipTo; - /** * @var AddressLocationInfo The place of business where you receive the customer's order. This address type is valid in the United States only and only applies to tangible personal property. */ public $pointOfOrderOrigin; - /** * @var AddressLocationInfo The place of business where you accept/approve the customer’s order, thereby becoming contractually obligated to make the sale. This address type is valid in the United States only and only applies to tangible personal property. */ public $pointOfOrderAcceptance; - /** * @var AddressLocationInfo The address where the goods are located or where services are rendered.This address type is valid only for VAT transactions. */ public $goodsPlaceOrServiceRendered; - /** * @var AddressLocationInfo The address of the buyer importing a good from another country.This address type is valid only for VAT transactions. */ public $import; - } - /** * Represents a transaction parameter. */ class TransactionParameterModel { - /** * @var string The name of the parameter. */ public $name; - /** * @var string The value of the parameter. */ public $value; - /** * @var string The unit of measure of the parameter value. */ public $unit; - } - /** * Represents a tax override for a transaction */ class TaxOverrideModel { - /** * @var string Identifies the type of tax override (See TaxOverrideType::* for a list of allowable values) */ public $type; - /** * @var float Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines. Tax will be distributed on a best effort basis. It may not always be possible to override all taxes. Please consult your account manager for information about overrides. */ public $taxAmount; - /** * @var string The override tax date to use This is used when the tax has been previously calculated as in the case of a layaway, return or other reason indicated by the Reason element. If the date is not overridden, then it should be set to the same as the DocDate. */ public $taxDate; - /** * @var string This provides the reason for a tax override for audit purposes. It is required for types 2-4. Typical reasons include: "Return" "Layaway" */ public $reason; - } - /** * Represents a transaction parameter. */ class TransactionLineParameterModel { - /** * @var string The name of the parameter. */ public $name; - /** * @var string The value of the parameter. */ public $value; - /** * @var string The unit of measure of the parameter value. */ public $unit; - } - /** * Represents an address to resolve. */ class AddressLocationInfo { - /** * @var string If you wish to use the address of an existing location for this company, specify the address here. Otherwise, leave this value empty. The `locationCode` field on this object allows you to quickly use the address of an existing `locationModel` object instead of having to retype the address completely. This field does not affect the behavior of transactions that must be filed on location-based tax returns. To specify how a transaction will be reported on location-based tax returns, please see the `reportingLocationCode` field on the [CreateTransactionModel](https://developer.avalara.com/api-reference/avatax/rest/v2/models/CreateTransactionModel/) element. */ public $locationCode; - /** * @var string First line of the street address */ public $line1; - /** * @var string Second line of the street address */ public $line2; - /** * @var string Third line of the street address */ public $line3; - /** * @var string City component of the address */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string 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`. */ public $country; - /** * @var string Postal Code / Zip Code component of the address. */ public $postalCode; - /** * @var float Geospatial latitude measurement, in Decimal Degrees floating point format. */ public $latitude; - /** * @var float Geospatial longitude measurement, in Decimal Degrees floating point format. */ public $longitude; - } - /** * Represents a create transaction batch response model. */ class CreateTransactionBatchResponseModel { - /** * @var int The unique ID number of this batch. */ public $id; - /** * @var string The user-friendly readable name for this batch. */ public $name; - /** * @var int The Account ID number of the account that owns this batch. */ public $accountId; - /** * @var int The Company ID number of the company that owns this batch. */ public $companyId; - /** * @var string This batch's current processing status (See BatchStatus::* for a list of allowable values) */ public $status; - /** * @var string The date/time when this batch started processing */ public $startedDate; - /** * @var int The number of records in this batch; determined by the server */ public $recordCount; - /** * @var int The current record being processed */ public $currentRecord; - /** * @var string The date/time when this batch was completely processed */ public $completedDate; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var BatchFileModel[] The list of files contained in this batch. */ public $files; - } - /** * Represents an invitation for a customer to use CertExpress to self-report their own certificates. * This invitation is delivered by your choice of method, or you can present a hyperlink to the user @@ -3931,52 +3134,41 @@ class CreateTransactionBatchResponseModel */ class CreateCertExpressInvitationModel { - /** * @var string If the value of `deliveryMethod` is set to `Email`, please specify the email address of the recipient for the request. */ public $recipient; - /** * @var string If this invitation is sent via email or download, please specify the cover letter to use when building this invitation. For a list of cover letters, please call `ListCoverLetters`. */ public $coverLetterTitle; - /** * @var int[] You may optionally specify a list of exposure zones to request in this CertExpress invitation. If you list more than one exposure zone, the customer will be prompted to provide an exemption certificate for each one. If you do not provide a list of exposure zones, the customer will be prompted to select an exposure zone. For a list of available exposure zones, please call `ListCertificateExposureZones`. */ public $exposureZones; - /** * @var int[] You may optionally specify a list of exemption reasons to pre-populate in this CertExpress invitation. If you list exemption reasons, the customer will have part of their form already filled in when they visit the CertExpress website. For a list of available exemption reasons, please call `ListCertificateExemptReasons`. */ public $exemptReasons; - /** * @var string Specify the type of invitation. CertExpress invitations can be delivered via email, web link, or facsimile. * If you specify `Email`, the invitation will be delivered via email. Please ask the customer to ensure that * If you specify `Fax`, the invitation will be sent via fax to the customer's fax number on file. * If you specify `Download`, the invitation will be prepared as a web link that you can display to the customer. (See CertificateRequestDeliveryMethod::* for a list of allowable values) */ public $deliveryMethod; - } - /** * Represent what is the current status of certificate request */ class CertExpressInvitationStatusModel { - /** * @var string The status of the CertExpress invitation for this customer. If this status says (See CertExpressInvitationStatus::* for a list of allowable values) */ public $status; - /** * @var CertExpressInvitationModel The CertExpress invitation for the customer. If you specified an email address in the invitation request, this invitation will be sent via email. Otherwise, you are expected to direct the customer using a hyperlink directly in your application. */ public $invitation; - } - /** * Represents an invitation for a customer to use CertExpress to self-report their own certificates. * This invitation is delivered by your choice of method, or you can present a hyperlink to the user @@ -3986,222 +3178,177 @@ class CertExpressInvitationStatusModel */ class CertExpressInvitationModel { - /** * @var int A unique ID number representing this CertExpress invitation. */ public $id; - /** * @var int The unique ID number of the AvaTax company that sent this invitation. */ public $companyId; - /** * @var string The email address to which this invitation was sent. If this invitation was presented as a weblink, this value will be null. */ public $recipient; - /** * @var string The unique code of the customer that received this invitation. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer. */ public $customerCode; - /** * @var CustomerModel The customer who received this invitation. */ public $customer; - /** * @var CoverLetterModel The attached cover letter object to this request. */ public $coverLetter; - /** * @var string The status of the emails associated with this invitation. If this invitation was sent via email, this value will change to `Sent` when the email message has been sent. */ public $emailStatus; - /** * @var boolean True if this invitation contained a cover letter only. */ public $coverLettersOnly; - /** * @var int[] When an invitation is sent, it contains a list of exposure zones for which the customer is invited to upload their exemption certificates. This list contains the ID numbers of the exposure zones identified. For a list of exposure zones, please call `ListCertificateExposureZones`. */ public $exposureZones; - /** * @var int[] The list of exemption reasons identified by this CertExpress invitation. For a list of reason codes, please call `ListCertificateExemptReasons`. */ public $exemptReasons; - /** * @var string Indicates the method that was used to deliver this CertExpress invitation. (See CertificateRequestDeliveryMethod::* for a list of allowable values) */ public $deliveryMethod; - /** * @var string The custom message delivered with this invitation. */ public $message; - /** * @var string The date of the invitation. */ public $date; - /** * @var string The web link (URL) that a customer can click on or visit to begin using this CertExpress invitation. This value is only usable if the status of this invitation is `Ready` and the request was created with type `Download`. NOTE: This link usually takes a few minutes to be available. */ public $requestLink; - } - /** * Represents a customer to whom you sell products and/or services. */ class CustomerModel { - /** * @var int Unique ID number of this customer. */ public $id; - /** * @var int The unique ID number of the AvaTax company that recorded this customer. */ public $companyId; - /** * @var string The unique code identifying this customer. Must be unique within your company. This code should be used in the `customerCode` field of any call that creates or adjusts a transaction in order to ensure that all exemptions that apply to this customer are correctly considered. Note: This field is case sensitive. */ public $customerCode; - /** * @var string A customer-configurable alternate ID number for this customer. You may set this value to match any other system that would like to reference this customer record. */ public $alternateId; - /** * @var string A friendly name identifying this customer. */ public $name; - /** * @var string Indicates the "Attn:" component of the address for this customer, if this customer requires mailings to be shipped to the attention of a specific person or department name. */ public $attnName; - /** * @var string First line of the street address of this customer. */ public $line1; - /** * @var string Second line of the street address of this customer. */ public $line2; - /** * @var string City component of the street address of this customer. */ public $city; - /** * @var string Postal Code / Zip Code component of the address of this customer. */ public $postalCode; - /** * @var string The main phone number for this customer. */ public $phoneNumber; - /** * @var string The fax phone number for this customer, if any. */ public $faxNumber; - /** * @var string The main email address for this customer. */ public $emailAddress; - /** * @var string The name of the main contact person for this customer. */ public $contactName; - /** * @var string Date when this customer last executed a transaction. */ public $lastTransaction; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var string 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`. */ public $country; - /** * @var string ISO 3166 code identifying the region within the country. Two and three character ISO 3166 region codes. For a full list of all supported codes, please see the Definitions API `ListRegions`. */ public $region; - /** * @var boolean True if this customer record is specifically used for bill-to purposes. */ public $isBill; - /** * @var boolean True if this customer record is specifically used for ship-to purposes. */ public $isShip; - /** * @var string For customers in the United States, this field is the federal taxpayer ID number. For businesses, this is a Federal Employer Identification Number. For individuals, this will be a Social Security Number. */ public $taxpayerIdNumber; - /** * @var CertificateModel[] A list of exemption certficates that apply to this customer. You can fetch this data by specifying `$include=certificates` when calling a customer fetch API. */ public $certificates; - /** * @var CustomFieldModel[] A list of custom fields defined on this customer. For more information about custom fields, see the [Avalara Help Center article about custom fields](https://help.avalara.com/0021_Avalara_CertCapture/All_About_CertCapture/Edit_or_Remove_Details_about_Customers). */ public $customFields; - /** * @var ExposureZoneModel[] A list of exposure zones where you do business with this customer. To keep track of certificates that are needed for each customer, set this value to a list of all exposure zones where you sell products to this customer. You can find a list of exposure zones by calling `ListExposureZones`. This field is often called "Ship-To States" or "Ship-To Zones", since it generally refers to locations where you ship products when this customer makes a purchase. This field is useful for audit purposes since it helps you ensure you have the necessary certificates for each customer. */ public $exposureZones; - /** * @var CustomerModel[] A list of ship-to customer records that are connected to this bill-to customer. Customer records represent businesses or individuals who can provide exemption certificates. Some customers may have certificates that are linked to their shipping address or their billing address. To group these customer records together, you may link multiple bill-to and ship-to addresses together to represent a single entity that has multiple different addresses of different kinds. */ public $shipTos; - /** * @var CustomerAttributeModel[] A list of attributes that apply to this customer. You can fetch this data by specifying `$include=attributes` when calling a customer fetch API. */ public $attributes; - } - /** * The CoverLetter model represents a message sent along with an invitation to use CertExpress to * upload certificates. An invitation allows customers to use CertExpress to upload their exemption @@ -4209,64 +3356,51 @@ class CustomerModel */ class CoverLetterModel { - /** * @var int A unique ID number representing a cover letter sent with a CertExpress invitation. */ public $id; - /** * @var int The unique ID number of the AvaTax company that received this certificate. */ public $companyId; - /** * @var string The title used when sending the cover letter. */ public $title; - /** * @var string The subject message used when sending the cover letter via email. */ public $subject; - /** * @var string A full description of the cover letter's contents and message. */ public $description; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var boolean Is this cover letter active */ public $active; - /** * @var int How many pages this cover letter encompasses */ public $pageCount; - /** * @var string The file name of the cover letter template */ public $templateFilename; - /** * @var int The version number of the template */ public $version; - } - /** * A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document * can contain information about a customer's eligibility for exemption from sales or use taxes based on @@ -4275,134 +3409,107 @@ class CoverLetterModel */ class CertificateModel { - /** * @var int Unique ID number of this certificate. */ public $id; - /** * @var int The unique ID number of the AvaTax company that recorded this certificate. */ public $companyId; - /** * @var string The date when this certificate was signed. */ public $signedDate; - /** * @var string Expiration date when this certificate will no longer be valid. */ public $expirationDate; - /** * @var string File name for the image of this certificate. When creating a certificate, if you do not upload a PDF or JPG image, you must specify the filename of the certificate as it is tracked in your repository. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them. */ public $filename; - /** * @var boolean This value is true if there exists scanned PDF copy of this certificate or the PDF version of the form that the customer filled via the CertCapture wizard on S3 bucket. */ public $documentExists; - /** * @var boolean True if this certificate is marked as valid. A valid certificate can be considered for exemption purposes. When a certificate is marked invalid, it will no longer be considered when calculating exemption for a customer. */ public $valid; - /** * @var boolean This value is true if the certificate has gone through the certificate validation process. For more information on the certificate validation process, please see the Avalara Help Center. */ public $verified; - /** * @var float If this certificate provides exemption from transactional taxes, what percentage of the transaction is considered exempt? For a fully exempt certificate, this percentage should be 100. */ public $exemptPercentage; - /** * @var boolean This value is true if this certificate is a single (or standalone) certificate. This value is set during the audit stage of the certificate validation process. */ public $isSingleCertificate; - /** * @var string Indicates the tax number passed in for the certificate. */ public $exemptionNumber; - /** * @var ExemptionReasonModel The exemption reason that CertCapture audit/internal logic identifies for created certificate. */ public $validatedExemptionReason; - /** * @var ExemptionReasonModel The exemption reason associated with this certificate. For example, the reason code for exemption for purposes of resale is `RESALE`. For a list of exemption reasons, call `ListCertificateExemptReasons`. */ public $exemptionReason; - /** * @var string The status of the certificate */ public $status; - /** * @var string The date/time when this record was created. */ public $createdDate; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int Number of pages contained within this certificate. */ public $pageCount; - /** * @var CustomerModel[] A list of customers to which this certificate applies. You can fetch this data by specifying `$include=customers` when calling a certificate fetch API. */ public $customers; - /** * @var PoNumberModel[] A list of purchase order numbers that are valid for use with this certificate. If this certificate is applicable for all purchase order numbers, this field will be empty. You can fetch this data by specifying `$include=po_numbers` when calling a certificate fetch API. */ public $poNumbers; - /** * @var ExposureZoneModel The exposure zone where this certificate is valid. */ public $exposureZone; - /** * @var CertificateAttributeModel[] A list of certificate attributes that apply to this certificate. You can fetch this data by specifying `$include=attributes` when calling a certificate fetch API. */ public $attributes; - /** * @var int The unique ID number of current AvaTax Exemption Certificate that refers this certificate. */ public $ecmsId; - /** * @var string The status of current AvaTax Exemption Certificate that refers to this certificate. */ public $ecmsStatus; - /** * @var string This field is available for input only. To retrieve the image after creation, use the `DownloadCertificateImage` API. When creating a certificate, you may optionally provide a PDF image in Base64 URLEncoded format. PDFs are automatically parsed into individual page JPG images and can be retrieved back later as either the original PDF or the individual pages. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them. */ public $pdf; - /** * @var string[] This field is available for input only. To retrieve the image after creation, use the `DownloadCertificateImage` API. When creating a certificate, you may optionally provide a list of JPG images, one per page, in Base64 URLEncoded format. These JPG images are automatically combined into a single downloadable PDF and can be retrieved back later as either the original JPG images or the combined PDF. To create a certificate, you must provide one of the following fields: either a `filename`, a `pdf` file, or an array of JPG `pages`. The API will return an error if you omit these fields or if you attempt to put values in more than one of them. */ public $pages; - } - /** * A custom field provides extra information about a customer or certificate. * @@ -4413,19 +3520,15 @@ class CertificateModel */ class CustomFieldModel { - /** * @var string The name of the custom field. */ public $name; - /** * @var string The value of the custom field. */ public $value; - } - /** * Information about a physical area or zone in which a certificate can apply. * An exposure zone for an exemption certificate will generally be a tax authority such @@ -4433,93 +3536,74 @@ class CustomFieldModel */ class ExposureZoneModel { - /** * @var int A unique ID number representing this exposure zone. */ public $id; - /** * @var int The unique ID number of the AvaTax company that recorded this customer. */ public $companyId; - /** * @var string The short name of this exposure zone, suitable for use in a drop-down list. */ public $name; - /** * @var string A tag indicating */ public $tag; - /** * @var string A more complete description of this exposure zone, suitable for use as a tooltip or help text. */ public $description; - /** * @var string The date when this record was created. */ public $created; - /** * @var string The date/time when this record was last modified. */ public $modified; - /** * @var string Two or three character ISO 3166 region, province, or state name of this exposure zone. */ public $region; - /** * @var string Two character ISO 3166 county code for the country component of this exposure zone. */ public $country; - } - /** * A Customer's linked attribute denoting what features applied to the customer. A customer can * be linked to multiple customer attributes and vice versa. */ class CustomerAttributeModel { - /** * @var int A unique ID number representing this attribute. */ public $id; - /** * @var string A friendly readable name for this attribute. */ public $name; - /** * @var string A full help text description of the attribute. */ public $description; - /** * @var boolean This value is true if this is a system-defined attribute. System-defined attributes cannot be modified or deleted on the CertCapture website. */ public $isSystemCode; - /** * @var boolean A flag denotes that future exemption certificate request won't be mailed to the customer */ public $isNonDeliver; - /** * @var boolean A flag denotes that this attribute can't be removed/added to a customer record */ public $isChangeable; - } - /** * 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, @@ -4527,37 +3611,29 @@ class CustomerAttributeModel */ class ExemptionReasonModel { - /** * @var int A unique ID number representing this exemption reason. */ public $id; - /** * @var string A friendly name describing this exemption reason. */ public $name; - } - /** * Represents a purchase order number for a transaction */ class PoNumberModel { - /** * @var int Unique ID number */ public $id; - /** * @var string Purchase order number. */ public $poNumber; - } - /** * A certificate attribute can be thought of as a feature or flag that is applied to a certificate. * A single certificate can be linked to zero, one, or many certificate attributes. The full list of @@ -4565,29 +3641,23 @@ class PoNumberModel */ class CertificateAttributeModel { - /** * @var int A unique ID number representing this certificate attribute. */ public $id; - /** * @var string A friendly readable name for this certificate attribute. */ public $name; - /** * @var string A full help text description of the certificate attribute. */ public $description; - /** * @var boolean This value is true if this is a system-defined certificate attribute. System-defined attributes cannot be modified or deleted on the CertCapture website. */ public $isSystemCode; - } - /** * Contains information about a company's exemption certificate status. * @@ -4596,2558 +3666,2029 @@ class CertificateAttributeModel */ class ProvisionStatusModel { - /** * @var string The status of exemption certificate setup for this company. If this value is `Finished`, this company will then be able to use the Customers, Certificates, and CertExpressInvites APIs within AvaTax. (See CertCaptureProvisionStatus::* for a list of allowable values) */ public $status; - /** * @var int The accountId of the company represented by this status */ public $accountId; - /** * @var int The AvaTax company represented by this status */ public $companyId; - } - /** * Represents a customer to whom you sell products and/or services. */ class LinkCustomersModel { - /** * @var string[] An array of customerCodes that are exempted by this certificate */ public $customers; - } - /** * A company and account */ class MrsCompanyModel { - /** * @var int The unique ID number of this company. */ public $companyId; - /** * @var string The name of this company, as shown to customers. */ public $companyName; - /** * @var int The unique ID number of the account this company belongs to. */ public $accountId; - /** * @var string The name of this account, as shown to customers. */ public $accountName; - /** * @var string The taxpayer identification number for the company */ public $tin; - /** * @var string The company code for the company */ public $companyCode; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Company Initialization Model */ class CompanyInitializationModel { - /** * @var string Company Name */ public $name; - /** * @var string Company Code - used to distinguish between companies within your accounting system */ public $companyCode; - /** * @var string Vat Registration Id - leave blank if not known. */ public $vatRegistrationId; - /** * @var string United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional. */ public $taxpayerIdNumber; - /** * @var boolean Set this field to true if the taxPayerIdNumber is a FEIN. */ public $isFein; - /** * @var string Address Line1 */ public $line1; - /** * @var string Line2 */ public $line2; - /** * @var string Line3 */ public $line3; - /** * @var string City */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string Postal Code */ public $postalCode; - /** * @var string 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`. */ public $country; - /** * @var string First Name */ public $firstName; - /** * @var string Last Name */ public $lastName; - /** * @var string Title */ public $title; - /** * @var string Email */ public $email; - /** * @var string Phone Number */ public $phoneNumber; - /** * @var string Mobile Number */ public $mobileNumber; - /** * @var string Fax Number */ public $faxNumber; - /** * @var int Parent Company ID */ public $parentCompanyId; - } - /** * Status of an Avalara Managed Returns funding configuration for a company */ class FundingStatusModel { - /** * @var int The unique ID number of this funding request */ public $requestId; - /** * @var int SubledgerProfileID */ public $subledgerProfileID; - /** * @var string CompanyID */ public $companyID; - /** * @var string Domain */ public $domain; - /** * @var string Recipient */ public $recipient; - /** * @var string Sender */ public $sender; - /** * @var string DocumentKey */ public $documentKey; - /** * @var string DocumentType */ public $documentType; - /** * @var string DocumentName */ public $documentName; - /** * @var FundingESignMethodReturn MethodReturn */ public $methodReturn; - /** * @var string Status */ public $status; - /** * @var string ErrorMessage */ public $errorMessage; - /** * @var string LastPolled */ public $lastPolled; - /** * @var string LastSigned */ public $lastSigned; - /** * @var string LastActivated */ public $lastActivated; - /** * @var int TemplateRequestId */ public $templateRequestId; - } - /** * Represents the current status of a funding ESign method */ class FundingESignMethodReturn { - /** * @var string Method */ public $method; - /** * @var boolean JavaScriptReady */ public $javaScriptReady; - /** * @var string The actual javascript to use to render this object */ public $javaScript; - } - /** * Status of an Avalara Managed Returns funding configuration for a company */ class FundingConfigurationModel { - /** * @var int CompanyID */ public $companyId; - /** * @var string Domain */ public $systemType; - /** * @var string Recipient */ public $currency; - /** * @var boolean Sender */ public $isFundingSetup; - /** * @var string DocumentKey */ public $fundingMethod; - /** * @var string LastPolled */ public $lastUpdated; - } - /** * */ class FundingInitiateModel { - /** * @var boolean Set this value to true to request an email to the recipient */ public $requestEmail; - /** * @var string If you have requested an email for funding setup, this is the recipient who will receive an email inviting them to setup funding configuration for Avalara Managed Returns. The recipient can then click on a link in the email and setup funding configuration for this company. */ public $fundingEmailRecipient; - /** * @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; - } - /** * Represents one configuration setting for this company */ class CompanyConfigurationModel { - /** * @var int The unique ID number of the account to which this setting applies */ public $companyId; - /** * @var string The category of the configuration setting. Avalara-defined categories include `AddressServiceConfig` and `TaxServiceConfig`. Customer-defined categories begin with `X-`. */ public $category; - /** * @var string The name of the configuration setting */ public $name; - /** * @var string The current value of the configuration setting */ public $value; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Represents a change request for filing status for a company */ class FilingStatusChangeModel { - /** * @var string Indicates the filing status you are requesting for this company (See CompanyFilingStatus::* for a list of allowable values) */ public $requestedStatus; - } - /** * The tax rate model. */ class ComplianceTaxRateModel { - /** * @var int The unique id of the rate. */ public $id; - /** * @var float The tax rate. */ public $rate; - /** * @var int The id of the jurisdiction. */ public $jurisdictionId; - /** * @var int The id of the tax region. */ public $taxRegionId; - /** * @var string The date this rate is starts to take effect. */ public $effectiveDate; - /** * @var string The date this rate is no longer active. */ public $endDate; - /** * @var string The rate type. */ public $rateTypeId; - /** * @var string The tax type. */ public $taxTypeId; - /** * @var string The name of the tax. */ public $taxName; - /** * @var int The unit of basis. */ public $unitOfBasisId; - /** * @var int The rate type tax type mapping id. */ public $rateTypeTaxTypeMappingId; - } - /** * The tax region model. */ class TaxRegionModel { - /** * @var int The id of the tax region. */ public $id; - /** * @var string The code of the tax region. */ public $code; - /** * @var string The name of the tax region. */ public $name; - /** * @var string The name of the county. */ public $county; - /** * @var string The name of the city. */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string Name or ISO 3166 code identifying the country of this jurisdiction. 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`. */ public $country; - /** * @var string The ser code. */ public $serCode; - /** * @var string The tax region signature code. */ public $signatureCode; - /** * @var string The date this tax region starts to take effect. */ public $effectiveDate; - /** * @var string The date this tax region stops to take effect. */ public $endDate; - /** * @var boolean Is Acm flag. */ public $isAcm; - /** * @var boolean Is SST flag. */ public $isSst; - /** * @var DenormalizedJurisModel[] List of jurisdictions associated with this tax region. */ public $jurisdictions; - } - /** * Represents information about a single legal taxing jurisdiction within a specific Avalara tax region. */ class DenormalizedJurisModel { - /** * @var string The jurisdiction's effective date. */ public $effectiveDate; - /** * @var string The jurisdiction's end date. */ public $endDate; - /** * @var string The jurisdiction's code. */ public $jurisCode; - /** * @var int The jurisdiction's id. */ public $jurisdictionId; - /** * @var string The jurisdiction's type. (See JurisdictionType::* for a list of allowable values) */ public $jurisType; - /** * @var string The jurisdiction's name. */ public $jurisName; - /** * @var string The state assigned code. */ public $stateAssignedCode; - /** * @var int The id of the tax authority. */ public $taxAuthorityId; - /** * @var string The jurisdiction's region. This should exist on the TaxRegion, but in practice often doesn't. */ public $state; - /** * @var string The jurisdiction's country. This should exist on the TaxRegion, but in practice often doesn't. */ public $country; - /** * @var string The jurisdiction's county. This should exist on the TaxRegion, but in practice often doesn't. */ public $county; - /** * @var string The jurisdiction's city. This should exist on the TaxRegion, but in practice often doesn't. */ public $city; - } - /** * The tax region jurisdiction model. */ class TaxRegionJurisdictionModel { - /** * @var int The id of the jurisdiction. */ public $jurisdictionId; - /** * @var int The id of the tax region. */ public $taxRegionId; - /** * @var int The id of the jurisdiction level. */ public $jurisdictionLevelId; - /** * @var string The rock name. */ public $rockName; - /** * @var int The report level. */ public $reportLevel; - /** * @var string The state assigned code. */ public $stateAssignedCode; - /** * @var int The id of the tax authority. */ public $taxAuthorityId; - /** * @var string The signature code. */ public $signatureCode; - /** * @var string The date in which this tax region jurisdiction starts to take effect. */ public $effectiveDate; - /** * @var string The date in which this tax region jurisdiction stops to take effect. */ public $endDate; - } - /** * Model for distinct jurisdictions. */ class ComplianceJurisdictionModel { - /** * @var int The id of the tax region. */ public $taxRegionId; - /** * @var string The state assigned code for the jurisdiction. */ public $stateAssignedCode; - /** * @var string The type of the jurisdiction, indicating whether it is a country, state/region, city, for example. */ public $jurisdictionTypeId; - /** * @var string The name of the jurisdiction. */ public $name; - /** * @var string The name of the county. */ public $county; - /** * @var string The name of the city. */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string Name or ISO 3166 code identifying the country of this jurisdiction. 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`. */ public $country; - /** * @var string The name of the tax region. */ public $taxRegionName; - /** * @var int The id of the tax authority. */ public $taxAuthorityId; - /** * @var ComplianceAggregatedTaxRateModel[] Optional: A list of rates for this jurisdiction. To fetch this list, add the query string `?$include=TaxRates` to your URL. */ public $rates; - } - /** * A model for aggregated rates. */ class ComplianceAggregatedTaxRateModel { - /** * @var float The compontent rate. */ public $rate; - /** * @var float The stack rate based on the aggregation method. */ public $stackRate; - /** * @var string The date this rate is starts to take effect. */ public $effectiveDate; - /** * @var string The date this rate is no longer active. */ public $endDate; - /** * @var string The tax type of the rate. */ public $taxTypeId; - /** * @var string The rate type of the rate. */ public $rateTypeId; - } - /** * A flattened model for jurisdictions and rates. */ class ComplianceJurisdictionRateModel { - /** * @var int The id of the jurisdiction. */ public $jurisdictionId; - /** * @var string Name or ISO 3166 code identifying the country of this jurisdiction. 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`. */ public $country; - /** * @var string 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`. */ public $region; - /** * @var string The name of the jurisdiction. */ public $name; - /** * @var string The type of the jurisdiction, indicating whether it is a country, state/region, city, for example. */ public $jurisdictionTypeId; - /** * @var float The compontent rate. */ public $rate; - /** * @var string The rate type. */ public $rateTypeId; - /** * @var string The tax type. */ public $taxTypeId; - /** * @var string The date this rate is starts to take effect. */ public $effectiveDate; - /** * @var string The date this rate is no longer active. */ public $endDate; - /** * @var string The state assigned code. */ public $stateAssignedCode; - /** * @var int The id of the tax authority. */ public $taxAuthorityId; - } - /** * Represents a fixup change */ class TransactionReferenceFieldModel { - /** * @var int The id of the transaction */ public $documentId; - /** * @var string Sets the sale location code (Outlet ID) for reporting this document to the tax authority. This value is used by Avalara Managed Returns to group documents together by reporting locations for tax authorities that require location-based reporting. */ public $reportingLocationCode; - /** * @var LineDetailSERCodeModel[] Reference field of the line details */ public $lineDetailSerCodes; - } - /** * SER code fixup */ class LineDetailSERCodeModel { - /** * @var int Transaction line detail Id */ public $transactionLineDetailId; - /** * @var string Updated SER code */ public $serCode; - } - /** * This object represents a single transaction; for example, a sales invoice or purchase order. */ class TransactionModel { - /** * @var int The unique ID number of this transaction. */ public $id; - /** * @var string A unique customer-provided code identifying this transaction. */ public $code; - /** * @var int The unique ID number of the company that recorded this transaction. */ public $companyId; - /** * @var string The date on which this transaction occurred. */ public $date; - /** * @var string DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null till its removed. The date when payment was made on this transaction. By default, this should be the same as the date of the transaction. */ public $paymentDate; - /** * @var string The status of the transaction. (See DocumentStatus::* for a list of allowable values) */ public $status; - /** * @var string The type of the transaction. Transactions of type `SalesOrder`, `ReturnOrder`, and so on are temporary estimates and will not be saved. Transactions of type `SalesInvoice, `ReturnInvoice`, and so on are permanent transactions that can be reported to tax authorities if they are in status `Committed`. A sales transaction represents a sale from the company to a customer. A purchase transaction represents a purchase made by the company. A return transaction represents a customer who decided to request a refund after purchasing a product from the company. An inventory transfer transaction represents goods that were moved from one location of the company to another location without changing ownership. (See DocumentType::* for a list of allowable values) */ public $type; - /** * @var string If this transaction was created as part of a batch, this code indicates which batch. */ public $batchCode; - /** * @var string The three-character ISO 4217 currency code that was used for payment for this transaction. */ public $currencyCode; - /** * @var string DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. The customer usage type for this transaction. Customer usage types often affect exemption or taxability rules. */ public $customerUsageType; - /** * @var string The entity use code for this transaction. Entity use codes often affect exemption or taxability rules. */ public $entityUseCode; - /** * @var string DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use `customerCode` This field has been renamed to `customerCode` to match documentation for other APIs related to exemption customers. */ public $customerVendorCode; - /** * @var string Unique code identifying the customer that requested this transaction. When you specify a `customerCode`, AvaTax will look to see if a customer exists with this code in the exemption certificate system. If that customer exists, and if that customer has uploaded an exemption certificate that applies to this transaction, the relevant parts of this transaction that can use the exemption certificate will be treated as exempt. */ public $customerCode; - /** * @var string The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options. */ public $exemptNo; - /** * @var boolean If this transaction has been reconciled against the company's ledger, this value is set to true. */ public $reconciled; - /** * @var string DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: In order to ensure consistency of field names, Please use reportingLocationCode instead. This field has been replaced by the reportingLocationCode field */ public $locationCode; - /** * @var string For customers who use [location-based tax reporting](https://developer.avalara.com/avatax/dev-guide/locations/location-based-reporting), this field controls how this transaction will be filed for multi-location tax filings. If you specify a non-null value for this field, AvaTax will ensure that this transaction is reported on the tax return associated with the [LocationModel](https://developer.avalara.com/api-reference/avatax/rest/v2/models/LocationModel/) identified by this code. This field does not affect any addresses for the transaction. It only controls the tax filing behavior of this transaction. If you are looking for information about how to set up addresses for a transaction, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/) in the AvaTax Developer Guide. */ public $reportingLocationCode; - /** * @var string The customer-supplied purchase order number of this transaction. */ public $purchaseOrderNo; - /** * @var string A user-defined reference code for this transaction. */ public $referenceCode; - /** * @var string The salesperson who provided this transaction. Not required. */ public $salespersonCode; - /** * @var string If a tax override was applied to this transaction, indicates what type of tax override was applied. (See TaxOverrideType::* for a list of allowable values) */ public $taxOverrideType; - /** * @var float If a tax override was applied to this transaction, indicates the amount of tax that was requested by the customer. */ public $taxOverrideAmount; - /** * @var string If a tax override was applied to this transaction, indicates the reason for the tax override. */ public $taxOverrideReason; - /** * @var float The total amount of this transaction. */ public $totalAmount; - /** * @var float The amount of this transaction that was exempt. */ public $totalExempt; - /** * @var float The total amount of discounts applied to all lines within this transaction. */ public $totalDiscount; - /** * @var float The total tax for all lines in this transaction. If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value may be different than the amount of tax calculated by AvaTax. The amount of tax calculated by AvaTax will be stored in the `totalTaxCalculated` field, whereas this field will contain the total tax that was charged on the transaction. You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax. */ public $totalTax; - /** * @var float The portion of the total amount of this transaction that was taxable. */ public $totalTaxable; - /** * @var float The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount` for any lines in this transaction, this value will represent the amount that AvaTax calculated for this transaction without applying the override. The field `totalTax` will be the total amount of tax after all overrides are applied. You can compare the `totalTax` and `totalTaxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax. */ public $totalTaxCalculated; - /** * @var string If this transaction was adjusted, indicates the unique ID number of the reason why the transaction was adjusted. (See AdjustmentReason::* for a list of allowable values) */ public $adjustmentReason; - /** * @var string If this transaction was adjusted, indicates a description of the reason why the transaction was adjusted. */ public $adjustmentDescription; - /** * @var boolean If this transaction has been reported to a tax authority, this transaction is considered locked and may not be adjusted after reporting. */ public $locked; - /** * @var string The two-or-three character ISO region code of the region for this transaction. */ public $region; - /** * @var string The two-character ISO 3166 code of the country for this transaction. */ public $country; - /** * @var int If this transaction was adjusted, this indicates the version number of this transaction. Incremented each time the transaction is adjusted. */ public $version; - /** * @var string The software version used to calculate this transaction. */ public $softwareVersion; - /** * @var int The unique ID number of the origin address for this transaction. */ public $originAddressId; - /** * @var int The unique ID number of the destination address for this transaction. */ public $destinationAddressId; - /** * @var string If this transaction included foreign currency exchange, this is the date as of which the exchange rate was calculated. */ public $exchangeRateEffectiveDate; - /** * @var float If this transaction included foreign currency exchange, this is the exchange rate that was used. */ public $exchangeRate; - /** * @var boolean By default, the value is null, when the value is null, the value can be set at nexus level and used. If the value is not null, it will override the value at nexus level. If true, this seller was considered the importer of record of a product shipped internationally. If this transaction is not an international transaction, this field may be left blank. The "importer of record" is liable to pay customs and import duties for products shipped internationally. If you specify that the seller is the importer of record, then estimates of customs and import duties will be added as tax details to the transaction. Otherwise, the buyer is considered the importer of record, and customs and import duties will not be added to the tax details for this transaction. */ public $isSellerImporterOfRecord; - /** * @var string Description of this transaction. Field permits unicode values. */ public $description; - /** * @var string Email address associated with this transaction. */ public $email; - /** * @var string VAT business identification number used for this transaction. */ public $businessIdentificationNo; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var string Tax date for this transaction */ public $taxDate; - /** * @var TransactionLineModel[] A list of line items in this transaction. To fetch this list, add the query string `?$include=Lines` or `?$include=Details` to your URL. */ public $lines; - /** * @var TransactionAddressModel[] A list of line items in this transaction. To fetch this list, add the query string `?$include=Addresses` to your URL. For more information about transaction addresses, please see [Using Address Types](https://developer.avalara.com/avatax/dev-guide/customizing-transaction/address-types/) in the AvaTax Developer Guide. */ public $addresses; - /** * @var TransactionLocationTypeModel[] A list of location types in this transaction. To fetch this list, add the query string `?$include=Addresses` to your URL. */ public $locationTypes; - /** * @var TransactionSummary[] Contains a summary of tax on this transaction. */ public $summary; - /** * @var TaxDetailsByTaxType[] Contains the tax details per tax type */ public $taxDetailsByTaxType; - /** * @var TransactionParameterModel[] Contains a list of extra parameters that were set when the transaction was created. */ public $parameters; - /** * @var AvaTaxMessage[] List of informational and warning messages regarding this API call. These messages are only relevant to the current API call. */ public $messages; - /** * @var InvoiceMessageModel[] Invoice messages associated with this document. Currently, this stores legally-required VAT messages. */ public $invoiceMessages; - } - /** * One line item on this transaction. */ class TransactionLineModel { - /** * @var int The unique ID number of this transaction line item. */ public $id; - /** * @var int The unique ID number of the transaction to which this line item belongs. */ public $transactionId; - /** * @var string The line number or code indicating the line on this invoice or receipt or document. */ public $lineNumber; - /** * @var int The unique ID number of the boundary override applied to this line item. */ public $boundaryOverrideId; - /** * @var string DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. The customer usage type for this line item. Usage type often affects taxability rules. */ public $customerUsageType; - /** * @var string The entity use code for this line item. Usage type often affects taxability rules. */ public $entityUseCode; - /** * @var string A description of the item or service represented by this line. */ public $description; - /** * @var int The unique ID number of the destination address where this line was delivered or sold. In the case of a point-of-sale transaction, the destination address and origin address will be the same. In the case of a shipped transaction, they will be different. */ public $destinationAddressId; - /** * @var int The unique ID number of the origin address where this line was delivered or sold. In the case of a point-of-sale transaction, the origin address and destination address will be the same. In the case of a shipped transaction, they will be different. */ public $originAddressId; - /** * @var float The amount of discount that was applied to this line item. This represents the difference between list price and sale price of the item. In general, a discount represents money that did not change hands; tax is calculated on only the amount of money that changed hands. */ public $discountAmount; - /** * @var int The type of discount, if any, that was applied to this line item. */ public $discountTypeId; - /** * @var float The amount of this line item that was exempt. */ public $exemptAmount; - /** * @var int The unique ID number of the exemption certificate that applied to this line item. It is the calc_id associated with a certificate in CertCapture. */ public $exemptCertId; - /** * @var string The CertCapture Certificate ID */ public $certificateId; - /** * @var string The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options. */ public $exemptNo; - /** * @var boolean True if this item is taxable. */ public $isItemTaxable; - /** * @var boolean True if this item is a Streamlined Sales Tax line item. */ public $isSSTP; - /** * @var string The code string of the item represented by this line item. */ public $itemCode; - /** * @var float The total amount of the transaction, including both taxable and exempt. This is the total price for all items. To determine the individual item price, divide this by quantity. */ public $lineAmount; - /** * @var float The quantity of products sold on this line item. */ public $quantity; - /** * @var string A user-defined reference identifier for this transaction line item. */ public $ref1; - /** * @var string A user-defined reference identifier for this transaction line item. */ public $ref2; - /** * @var string The date when this transaction should be reported. By default, all transactions are reported on the date when the actual transaction took place. In some cases, line items may be reported later due to delayed shipments or other business reasons. */ public $reportingDate; - /** * @var string The revenue account number for this line item. */ public $revAccount; - /** * @var string Indicates whether this line item was taxed according to the origin or destination. (See Sourcing::* for a list of allowable values) */ public $sourcing; - /** * @var float The tax for this line in this transaction. If you used a `taxOverride` of type `taxAmount` for this line, this value will represent the amount of your override. AvaTax will still attempt to calculate the correct tax for this line and will store that calculated value in the `taxCalculated` field. You can compare the `tax` and `taxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax. */ public $tax; - /** * @var float The taxable amount of this line item. */ public $taxableAmount; - /** * @var float The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount`, there may be a difference between the `tax` field which applies your override, and the `taxCalculated` field which represents the amount of tax that AvaTax calculated without the override. You can compare the `tax` and `taxCalculated` fields to check for any discrepancies between an external tax calculation provider and the calculation performed by AvaTax. */ public $taxCalculated; - /** * @var string The code string for the tax code that was used to calculate this line item. */ public $taxCode; - /** * @var int The unique ID number for the tax code that was used to calculate this line item. */ public $taxCodeId; - /** * @var string The date that was used for calculating tax amounts for this line item. By default, this date should be the same as the document date. In some cases, for example when a consumer returns a product purchased previously, line items may be calculated using a tax date in the past so that the consumer can receive a refund for the correct tax amount that was charged when the item was originally purchased. */ public $taxDate; - /** * @var string The tax engine identifier that was used to calculate this line item. */ public $taxEngine; - /** * @var string If a tax override was specified, this indicates the type of tax override. (See TaxOverrideType::* for a list of allowable values) */ public $taxOverrideType; - /** * @var string VAT business identification number used for this transaction. */ public $businessIdentificationNo; - /** * @var float If a tax override was specified, this indicates the amount of tax that was requested. */ public $taxOverrideAmount; - /** * @var string If a tax override was specified, represents the reason for the tax override. */ public $taxOverrideReason; - /** * @var boolean Indicates whether the `amount` for this line already includes tax. If this value is `true`, the final price of this line including tax will equal the value in `amount`. If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line. */ public $taxIncluded; - /** * @var TransactionLineDetailModel[] Optional: A list of tax details for this line item. Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `details` collection are intended to be displayed to the customer and charged as a 'tax' on the invoice. To fetch this list, add the query string `?$include=Details` to your URL. */ public $details; - /** * @var TransactionLineDetailModel[] Optional: A list of non-passthrough tax details for this line item. Tax details represent taxes being charged by various tax authorities. Taxes that appear in the `nonPassthroughDetails` collection are taxes that must be paid directly by the company and not shown to the customer. */ public $nonPassthroughDetails; - /** * @var TransactionLineLocationTypeModel[] Optional: A list of location types for this line item. To fetch this list, add the query string "?$include=LineLocationTypes" to your URL. */ public $lineLocationTypes; - /** * @var TransactionLineParameterModel[] Contains a list of extra parameters that were set when the transaction was created. */ public $parameters; - /** * @var string The cross-border harmonized system code (HSCode) used to calculate tariffs and duties for this line item. For a full list of HS codes, see `ListCrossBorderCodes()`. */ public $hsCode; - /** * @var float Indicates the cost of insurance and freight for this line. */ public $costInsuranceFreight; - /** * @var string Indicates the VAT code for this line item. */ public $vatCode; - /** * @var int Indicates the VAT number type for this line item. */ public $vatNumberTypeId; - } - /** * An address used within this transaction. */ class TransactionAddressModel { - /** * @var int The unique ID number of this address. */ public $id; - /** * @var int The unique ID number of the document to which this address belongs. */ public $transactionId; - /** * @var string The boundary level at which this address was validated. (See BoundaryLevel::* for a list of allowable values) */ public $boundaryLevel; - /** * @var string The first line of the address. */ public $line1; - /** * @var string The second line of the address. */ public $line2; - /** * @var string The third line of the address. */ public $line3; - /** * @var string The city for the address. */ public $city; - /** * @var string The ISO 3166 region code. E.g., the second part of ISO 3166-2. */ public $region; - /** * @var string The postal code or zip code for the address. */ public $postalCode; - /** * @var string The ISO 3166 country code */ public $country; - /** * @var int The unique ID number of the tax region for this address. */ public $taxRegionId; - /** * @var string Latitude for this address */ public $latitude; - /** * @var string Longitude for this address */ public $longitude; - } - /** * Information about a location type */ class TransactionLocationTypeModel { - /** * @var int Location type ID for this location type in transaction */ public $documentLocationTypeId; - /** * @var int Transaction ID */ public $documentId; - /** * @var int Address ID for the transaction */ public $documentAddressId; - /** * @var string Location type code */ public $locationTypeCode; - } - /** * Summary information about an overall transaction. */ class TransactionSummary { - /** * @var string Two character ISO-3166 country code. */ public $country; - /** * @var string Two or three character ISO region, state or province code, if applicable. */ public $region; - /** * @var string The type of jurisdiction that collects this tax. (See JurisdictionType::* for a list of allowable values) */ public $jurisType; - /** * @var string Jurisdiction Code for the taxing jurisdiction */ public $jurisCode; - /** * @var string The name of the jurisdiction that collects this tax. */ public $jurisName; - /** * @var int The unique ID of the Tax Authority Type that collects this tax. */ public $taxAuthorityType; - /** * @var string The state assigned number of the jurisdiction that collects this tax. */ public $stateAssignedNo; - /** * @var string The tax type of this tax. */ public $taxType; - /** * @var string The tax subtype of this tax. */ public $taxSubType; - /** * @var string The name of the tax. */ public $taxName; - /** * @var string Group code when special grouping is enabled. */ public $taxGroup; - /** * @var string DEPRECATED - Date: 3/1/2018, Version: 18.3, Message: Please use rateTypeCode instead. Indicates the tax rate type. (See RateType::* for a list of allowable values) */ public $rateType; - /** * @var string Indicates the code of the rate type. Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes. */ public $rateTypeCode; - /** * @var float Tax Base - The adjusted taxable amount. */ public $taxable; - /** * @var float Tax Rate - The rate of taxation, as a fraction of the amount. */ public $rate; - /** * @var float Tax amount - The calculated tax (Base * Rate). */ public $tax; - /** * @var float The amount of tax that AvaTax calculated for the transaction. If you used a `taxOverride` of type `taxAmount`, there may be a difference between the `tax` field which applies your override, and the `TaxCalculated` field which represents the amount of tax that AvaTax calculated for this transaction without override. You can use this for comparison. */ public $taxCalculated; - /** * @var float The amount of the transaction that was non-taxable. */ public $nonTaxable; - /** * @var float The amount of the transaction that was exempt. */ public $exemption; - } - /** * Tax Details by Tax Type */ class TaxDetailsByTaxType { - /** * @var string Tax Type */ public $taxType; - /** * @var float Total taxable amount by tax type */ public $totalTaxable; - /** * @var float Total exempt by tax type */ public $totalExempt; - /** * @var float Total non taxable by tax type */ public $totalNonTaxable; - /** * @var float Total tax by tax type */ public $totalTax; - /** * @var TaxDetailsByTaxSubType[] Tax subtype details */ public $taxSubTypeDetails; - } - /** * Represents a message to be displayed on an invoice. */ class InvoiceMessageModel { - /** * @var string The content of the invoice message. */ public $content; - /** * @var string[] The applicable tax line numbers and codes. */ public $lineNumbers; - } - /** * An individual tax detail element. Represents the amount of tax calculated for a particular jurisdiction, for a particular line in an invoice. */ class TransactionLineDetailModel { - /** * @var int The unique ID number of this tax detail. */ public $id; - /** * @var int The unique ID number of the line within this transaction. */ public $transactionLineId; - /** * @var int The unique ID number of this transaction. */ public $transactionId; - /** * @var int The unique ID number of the address used for this tax detail. */ public $addressId; - /** * @var string The two character ISO 3166 country code of the country where this tax detail is assigned. */ public $country; - /** * @var string The two-or-three character ISO region code for the region where this tax detail is assigned. */ public $region; - /** * @var string For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the county where this tax detail is assigned. */ public $countyFIPS; - /** * @var string For U.S. transactions, the Federal Information Processing Standard (FIPS) code for the state where this tax detail is assigned. */ public $stateFIPS; - /** * @var float The amount of this line that was considered exempt in this tax detail. */ public $exemptAmount; - /** * @var int The unique ID number of the exemption reason for this tax detail. */ public $exemptReasonId; - /** * @var boolean True if this detail element represented an in-state transaction. */ public $inState; - /** * @var string The code of the jurisdiction to which this tax detail applies. */ public $jurisCode; - /** * @var string The name of the jurisdiction to which this tax detail applies. */ public $jurisName; - /** * @var int The unique ID number of the jurisdiction to which this tax detail applies. */ public $jurisdictionId; - /** * @var string The Avalara-specified signature code of the jurisdiction to which this tax detail applies. */ public $signatureCode; - /** * @var string The state assigned number of the jurisdiction to which this tax detail applies. */ public $stateAssignedNo; - /** * @var string DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Use jurisdictionTypeId instead. The type of the jurisdiction to which this tax detail applies. (See JurisTypeId::* for a list of allowable values) */ public $jurisType; - /** * @var string The type of the jurisdiction in which this tax detail applies. (See JurisdictionType::* for a list of allowable values) */ public $jurisdictionType; - /** * @var float The amount of this line item that was considered nontaxable in this tax detail. */ public $nonTaxableAmount; - /** * @var int The rule according to which portion of this detail was considered nontaxable. */ public $nonTaxableRuleId; - /** * @var string The type of nontaxability that was applied to this tax detail. (See TaxRuleTypeId::* for a list of allowable values) */ public $nonTaxableType; - /** * @var float The rate at which this tax detail was calculated. */ public $rate; - /** * @var int The unique ID number of the rule according to which this tax detail was calculated. */ public $rateRuleId; - /** * @var int The unique ID number of the source of the rate according to which this tax detail was calculated. */ public $rateSourceId; - /** * @var string For Streamlined Sales Tax customers, the SST Electronic Return code under which this tax detail should be applied. */ public $serCode; - /** * @var string Indicates whether this tax detail applies to the origin or destination of the transaction. (See Sourcing::* for a list of allowable values) */ public $sourcing; - /** * @var float The amount of tax for this tax detail. */ public $tax; - /** * @var float The taxable amount of this tax detail. */ public $taxableAmount; - /** * @var string The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws. */ public $taxType; - /** * @var string The id of the tax subtype. */ public $taxSubTypeId; - /** * @var string The id of the tax type group. */ public $taxTypeGroupId; - /** * @var string The name of the tax against which this tax amount was calculated. */ public $taxName; - /** * @var int The type of the tax authority to which this tax will be remitted. */ public $taxAuthorityTypeId; - /** * @var int The unique ID number of the tax region. */ public $taxRegionId; - /** * @var float The amount of tax that AvaTax calculated. If an override for tax amount is used, there may be a difference between the tax field which applies your override, and the this amount that is calculated without override. */ public $taxCalculated; - /** * @var float The amount of tax override that was specified for this tax line. */ public $taxOverride; - /** * @var string DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use rateTypeCode instead. The rate type for this tax detail. (See RateType::* for a list of allowable values) */ public $rateType; - /** * @var string Indicates the code of the rate type that was used to calculate this tax detail. Use [ListRateTypesByCountry](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListRateTypesByCountry/) API for a full list of rate type codes. */ public $rateTypeCode; - /** * @var float Number of units in this line item that were calculated to be taxable according to this rate detail. */ public $taxableUnits; - /** * @var float Number of units in this line item that were calculated to be nontaxable according to this rate detail. */ public $nonTaxableUnits; - /** * @var float Number of units in this line item that were calculated to be exempt according to this rate detail. */ public $exemptUnits; - /** * @var string When calculating units, what basis of measurement did we use for calculating the units? */ public $unitOfBasis; - /** * @var boolean True if this value is a non-passthrough tax. A non-passthrough tax is a tax that may not be charged to a customer; it must be paid directly by the company. */ public $isNonPassThru; - /** * @var boolean The Taxes/Fee component. True if the fee is applied. */ public $isFee; - } - /** * Represents information about location types stored in a line */ class TransactionLineLocationTypeModel { - /** * @var int The unique ID number of this line location address model */ public $documentLineLocationTypeId; - /** * @var int The unique ID number of the document line associated with this line location address model */ public $documentLineId; - /** * @var int The address ID corresponding to this model */ public $documentAddressId; - /** * @var string The location type code corresponding to this model */ public $locationTypeCode; - } - /** * Tax Details by Tax subtype */ class TaxDetailsByTaxSubType { - /** * @var string Tax subtype */ public $taxSubType; - /** * @var float Total taxable amount by tax type */ public $totalTaxable; - /** * @var float Total exempt by tax type */ public $totalExempt; - /** * @var float Total non taxable by tax type */ public $totalNonTaxable; - /** * @var float Total tax by tax type */ public $totalTax; - } - /** * Represents a customer to whom you sell products and/or services. */ class LinkCertificatesModel { - /** * @var int[] An array of certificate ID numbers to link */ public $certificates; - } - /** * Indicates the customer's exemption status in a specific country and region. */ class ExemptionStatusModel { - /** * @var string The exemption status of this customer in this country/region. */ public $status; - /** * @var CertificateModel Certificate if the customer is exempted */ public $certificate; - } - /** * Data source object */ class DataSourceModel { - /** * @var int The id of the datasource. */ public $id; - /** * @var int The id of the company to which the datasource belongs to. */ public $companyId; - /** * @var string The extractor/connector id. */ public $source; - /** * @var string The unique ID number of this connection. */ public $instance; - /** * @var boolean The connection using the connection_id is enabled. The customer is responsible to enable or disable. */ public $isEnabled; - /** * @var boolean If all the information has been transferred from the extractor to the database. */ public $isSynced; - /** * @var boolean True if this data source is authorized. */ public $isAuthorized; - /** * @var string The date when the information was last synched. */ public $lastSyncedDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var string The date when this record was deleted. */ public $deletedDate; - /** * @var boolean Specifies whether transactions created by this data source needs to re-calculate tax or not */ public $recalculate; - /** * @var string Specifies the name of the extractor */ public $name; - /** * @var string Specifies any implementation-specific information along with the DataSource.This field has no internal meaning in AvaTax and is purely for the convenience of the DataSource API user */ public $externalState; - } - /** * Identifies all nexus that match a particular tax form */ class NexusByTaxFormModel { - /** * @var string The code of the tax form that was requested */ public $formCode; - /** * @var int The company ID of the company that was used to load the companyNexus array. If this value is null, no company data was loaded. */ public $companyId; - /** * @var NexusModel[] A list of all Avalara-defined nexus that are relevant to this tax form */ public $nexusDefinitions; - /** * @var NexusModel[] A list of all currently-defined company nexus that are related to this tax form */ public $companyNexus; - } - /** * Information about Avalara-defined tax code types. * This list is used when creating tax codes and tax rules. */ class TaxCodeTypesModel { - /** * @var object The list of Avalara-defined tax code types. */ public $types; - } - /** * Represents a service or a subscription type. */ class SubscriptionTypeModel { - /** * @var int The unique ID number of this subscription type. */ public $id; - /** * @var string The friendly name of the service this subscription type represents. */ public $description; - } - /** * Represents a single security role. */ class SecurityRoleModel { - /** * @var int The unique ID number of this security role. */ public $id; - /** * @var string A description of this security role */ public $description; - } - /** * Tax Authority Model */ class TaxAuthorityModel { - /** * @var int The unique ID number of this tax authority. */ public $id; - /** * @var string The friendly name of this tax authority. */ public $name; - /** * @var int The type of this tax authority. */ public $taxAuthorityTypeId; - /** * @var int The unique ID number of the jurisdiction for this tax authority. */ public $jurisdictionId; - } - /** * Represents a form that can be filed with a tax authority. */ class TaxAuthorityFormModel { - /** * @var int The unique ID number of the tax authority. */ public $taxAuthorityId; - /** * @var string The form name of the form for this tax authority. */ public $formName; - } - /** * usage of system defined parameters. */ class ParameterUsageModel { - /** * @var int The unique ID number of this property. */ public $id; - /** * @var int The id of the parameter. */ public $parameterId; - /** * @var string Product code for the parameter usage item. */ public $productCode; - /** * @var string The country for the parameter usage item. */ public $country; - /** * @var string The state for the parameter usage item. */ public $region; - /** * @var int System Id for the parameter usage item */ public $systemId; - /** * @var string tax type for the parameter usage item. */ public $taxTypeId; - /** * @var string The type of parameter as determined by its application, e.g. Product, Transaction, Calculated */ public $attributeType; - /** * @var string The name of the property. To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call. */ public $name; - /** * @var string The data type of the property. */ public $dataType; - /** * @var string Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter. */ public $helpText; - /** * @var string Label that helps the user to identify a parameter */ public $label; - /** * @var string A help url that provides more information about the parameter */ public $helpUrl; - /** * @var string[] If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values. */ public $values; - /** * @var string The unit of measurement type of the parameter */ public $measurementType; - } - /** * An extra property that can change the behavior of tax transactions. */ class ParameterModel { - /** * @var int The unique ID number of this property. */ public $id; - /** * @var string DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The category grouping of this parameter. When your user interface displays a large number of parameters, they should be grouped by their category value. */ public $category; - /** * @var string The name of the property. To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call. */ public $name; - /** * @var string The data type of the property. */ public $dataType; - /** * @var string Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter. */ public $helpText; - /** * @var string[] A list of service types to which this parameter applies. */ public $serviceTypes; - /** * @var string DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The prompt you should use when displaying this parameter to a user. For example, if your user interface displays a parameter in a text box, this is the label you should use to identify that text box. */ public $prompt; - /** * @var string DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. If your user interface permits client-side validation of parameters, this string is a regular expression you can use to validate the user's data entry prior to submitting a tax request. */ public $regularExpression; - /** * @var string Label that helps the user to identify a parameter */ public $label; - /** * @var string A help url that provides more information about the parameter */ public $helpUrl; - /** * @var string The type of parameter as determined by its application, e.g. Product, Transaction, Calculated */ public $attributeType; - /** * @var string[] If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values. */ public $values; - /** * @var string The unit of measurement type of the parameter */ public $measurementType; - } - /** * Information about questions that the local jurisdictions require for each location */ class LocationQuestionModel { - /** * @var int The unique ID number of this location setting type */ public $id; - /** * @var string This is the prompt for this question */ public $question; - /** * @var string If additional information is available about the location setting, this contains descriptive text to help you identify the correct value to provide in this setting. */ public $description; - /** * @var string If available, this regular expression will verify that the input from the user is in the expected format. */ public $regularExpression; - /** * @var string If available, this is an example value that you can demonstrate to the user to show what is expected. */ public $exampleValue; - /** * @var string Indicates which jurisdiction requires this question */ public $jurisdictionName; - /** * @var string Indicates which type of jurisdiction requires this question (See JurisdictionType::* for a list of allowable values) */ public $jurisdictionType; - /** * @var string Indicates the country that this jurisdiction belongs to */ public $jurisdictionCountry; - /** * @var string Indicates the state, region, or province that this jurisdiction belongs to */ public $jurisdictionRegion; - } - /** * Represents an ISO 3166 recognized country */ class IsoCountryModel { - /** * @var string The two character ISO 3166 country code */ public $code; - /** * @var string The three character ISO 3166 country code */ public $alpha3Code; - /** * @var string The full name of this country in uppercase. For names in proper or formal case, or for names in other languages, please examine the `localizedNames` element for an appropriate name. */ public $name; - /** * @var boolean True if this country is a member of the European Union */ public $isEuropeanUnion; - /** * @var IsoLocalizedName[] A list of localized names in a variety of languages. This list is maintained by the International Standards Organization. */ public $localizedNames; - /** * @var boolean Whether or not this country requires a region in postal addresses. */ public $addressesRequireRegion; - } - /** * Represents a language-specific localized name of a particular geographic entity such * as a country or a region. */ class IsoLocalizedName { - /** * @var string The two-character alphanumeric code identifying the language in which this name is used. Note that languageAlpha2Code and language3AlphaCode refer to the same language. */ public $languageAlpha2Code; - /** * @var string The three-character alphanumeric code identifying the language in which this name is used. Note that languageAlpha2Code and language3AlphaCode refer to the same language. */ public $languageAlpha3Code; - /** * @var string The name of this geographic entity as known in this language. */ public $name; - } - /** * Represents a region, province, or state within a country */ class IsoRegionModel { - /** * @var string The two-character ISO 3166 country code this region belongs to */ public $countryCode; - /** * @var string The three character ISO 3166 region code */ public $code; - /** * @var string The full name, using localized characters, for this region, in uppercase. For names in proper or formal case, or for names in other languages, please examine the `localizedNames` element for an appropriate name. */ public $name; - /** * @var string The word in the local language that classifies what type of a region this represents */ public $classification; - /** * @var boolean For the United States, this flag indicates whether a U.S. State participates in the Streamlined Sales Tax program. For countries other than the US, this flag is null. */ public $streamlinedSalesTax; - /** * @var IsoLocalizedName[] A list of localized names in a variety of languages. This list is maintained by the International Standards Organization. */ public $localizedNames; - } - /** * Represents a code describing the intended use for a product that may affect its taxability */ class EntityUseCodeModel { - /** * @var string The Avalara-recognized entity use code for this definition */ public $code; - /** * @var string The name of this entity use code */ public $name; - /** * @var string Text describing the meaning of this use code */ public $description; - /** * @var string[] A list of countries where this use code is valid */ public $validCountries; - } - /** * A preferred program is a customs and/or duty program that can be used to handle cross-border transactions. * Customers who sign up for a preferred program may obtain better terms for their customs and duty payments. @@ -7157,487 +5698,383 @@ class EntityUseCodeModel */ class PreferredProgramModel { - /** * @var int The unique ID number representing this preferred program. */ public $id; - /** * @var string A code that identifies this preferred program. To select this program, specify this code value in the `AvaTax.LC.PreferredProgram` parameter. */ public $code; - /** * @var string The ISO 3166 country code for the origin permitted by this program */ public $originCountry; - /** * @var string The ISO 3166 country code for the destination permitted by this program */ public $destinationCountry; - /** * @var string The earliest date for which this preferred program can be used in AvaTax. If `null`, this preferred program is valid for all dates earlier than `endDate`. */ public $effectiveDate; - /** * @var string The latest date for which this preferred program can be used in AvaTax. If `null`, this preferred program is valid for all dates later than `effectiveDate`. */ public $endDate; - } - /** * Represents an ISO 4217 currency code used for designating the currency of a transaction. */ class CurrencyModel { - /** * @var string The ISO 4217 currency code for this currency. */ public $code; - /** * @var string A friendly human-readable name representing this currency. */ public $description; - /** * @var int The number of decimal digits to use when formatting a currency value for display. */ public $decimalDigits; - } - /** * Represents a product classification system. */ class ProductClassificationSystemModel { - /** * @var int Its Integer SystemId value for System */ public $systemId; - /** * @var string The System code for this System. */ public $systemCode; - /** * @var string A friendly human-readable name representing this System. */ public $description; - /** * @var string custom value set for the system */ public $customsValue; - /** * @var ProductSystemCountryModel[] List of all countries that belong to the system including */ public $countries; - } - /** * Represents a System Country. */ class ProductSystemCountryModel { - /** * @var int Its Integer SystemCountryId value for SystemCountry */ public $systemCountryId; - /** * @var int Its Integer SystemId value for SystemCountry */ public $systemId; - /** * @var string string value of country code for SystemCountry */ public $country; - /** * @var string DateTime as EffDate for SystemCountry */ public $effDate; - /** * @var string DateTime as EffDate for SystemCountry */ public $endDate; - } - /** * Tax Authority Type Model */ class TaxAuthorityTypeModel { - /** * @var int The unique ID number of this tax Authority customer type. */ public $id; - /** * @var string The description name of this tax authority type. */ public $description; - /** * @var string Tax Authority Group */ public $taxAuthorityGroup; - } - /** * Tax Notice Status Model */ class NoticeStatusModel { - /** * @var int The unique ID number of this tax authority type. */ public $id; - /** * @var string The description name of this tax authority type. */ public $description; - /** * @var boolean True if a tax notice in this status is considered 'open' and has more work expected to be done before it is closed. */ public $isOpen; - /** * @var int If a list of status values is to be displayed in a dropdown, they should be displayed in this numeric order. */ public $sortOrder; - } - /** * Tax Authority Model */ class NoticeCustomerTypeModel { - /** * @var int The unique ID number of this tax notice customer type. */ public $id; - /** * @var string The description name of this tax authority type. */ public $description; - /** * @var boolean A flag if the type is active */ public $activeFlag; - /** * @var int sort order of the types */ public $sortOrder; - } - /** * Tax Notice Reason Model */ class NoticeReasonModel { - /** * @var int The unique ID number of this tax notice customer type. */ public $id; - /** * @var string The description name of this tax authority type. */ public $description; - /** * @var boolean A flag if the type is active */ public $activeFlag; - /** * @var int sort order of the types */ public $sortOrder; - } - /** * FilingFrequency Model */ class FilingFrequencyModel { - /** * @var int The unique ID number of this filing frequency. */ public $id; - /** * @var string The description name of this filing frequency */ public $description; - } - /** * Tax Notice FilingType Model */ class NoticeFilingTypeModel { - /** * @var int The unique ID number of this tax notice customer type. */ public $id; - /** * @var string The description name of this tax authority type. */ public $description; - /** * @var boolean A flag if the type is active */ public $activeFlag; - /** * @var int sort order of the types */ public $sortOrder; - } - /** * Tax Notice Type Model */ class NoticeTypeModel { - /** * @var int The unique ID number of this tax notice customer type. */ public $id; - /** * @var string The description name of this tax authority type. */ public $description; - /** * @var boolean A flag if the type is active */ public $activeFlag; - /** * @var int sort order of the types */ public $sortOrder; - } - /** * Tax Authority Model */ class NoticeCustomerFundingOptionModel { - /** * @var int The unique ID number of this tax notice customer FundingOption. */ public $id; - /** * @var string The description name of this tax authority FundingOption. */ public $description; - /** * @var boolean A flag if the FundingOption is active */ public $activeFlag; - /** * @var int sort order of the FundingOptions */ public $sortOrder; - } - /** * Tax Notice Priority Model */ class NoticePriorityModel { - /** * @var int The unique ID number of this tax notice customer Priority. */ public $id; - /** * @var string The description name of this tax authority Priority. */ public $description; - /** * @var boolean A flag if the Priority is active */ public $activeFlag; - /** * @var int sort order of the Prioritys */ public $sortOrder; - } - /** * NoticeResponsibility Model */ class NoticeResponsibilityModel { - /** * @var int The unique ID number of this notice responsibility. */ public $id; - /** * @var string The description name of this notice responsibility */ public $description; - /** * @var boolean Defines if the responsibility is active */ public $isActive; - /** * @var int The sort order of this responsibility */ public $sortOrder; - } - /** * NoticeRootCause Model */ class NoticeRootCauseModel { - /** * @var int The unique ID number of this notice RootCause. */ public $id; - /** * @var string The description name of this notice RootCause */ public $description; - /** * @var boolean Defines if the RootCause is active */ public $isActive; - /** * @var int The sort order of this RootCause */ public $sortOrder; - } - /** * Represents a list of statuses of returns available in skyscraper */ class SkyscraperStatusModel { - /** * @var string The specific name of the returns available in skyscraper */ public $name; - /** * @var string[] The tax form codes available to file through skyscrper */ public $taxFormCodes; - /** * @var string The country of the returns */ public $country; - /** * @var string The Scraper type (See ScraperType::* for a list of allowable values) */ public $scraperType; - /** * @var boolean Indicates if the return is currently available */ public $isAvailable; - /** * @var string The expected response time of the call */ public $expectedResponseTime; - /** * @var string Message on the returns */ public $message; - /** * @var requiredFilingCalendarDataFieldModel[] A list of required fields to file */ public $requiredFilingCalendarDataFields; - } - /** * Represents a verification request using Skyscraper for a company */ class requiredFilingCalendarDataFieldModel { - /** * @var string Region of the verification request */ public $name; - /** * @var string Username that we are using for verification */ public $description; - } - /** * Represents an override of tax jurisdictions for a specific address. * @@ -7646,931 +6083,741 @@ class requiredFilingCalendarDataFieldModel */ class JurisdictionOverrideModel { - /** * @var int The unique ID number of this override. */ public $id; - /** * @var int The unique ID number assigned to this account. */ public $accountId; - /** * @var string A description of why this jurisdiction override was created. */ public $description; - /** * @var string The street address of the physical location affected by this override. */ public $line1; - /** * @var string The city address of the physical location affected by this override. */ public $city; - /** * @var string Name or ISO 3166 code identifying the region within the country to be affected by this override. Note that only United States addresses are affected by the jurisdiction override system. 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`. */ public $region; - /** * @var string The two character ISO-3166 country code of the country affected by this override. Note that only United States addresses are affected by the jurisdiction override system. */ public $country; - /** * @var string The postal code of the physical location affected by this override. */ public $postalCode; - /** * @var string The date when this override first takes effect. Set this value to null to affect all dates up to the end date. */ public $effectiveDate; - /** * @var string The date when this override will cease to take effect. Set this value to null to never expire. */ public $endDate; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var JurisdictionModel[] A list of the tax jurisdictions that will be assigned to this overridden address. */ public $jurisdictions; - /** * @var int The TaxRegionId of the new location affected by this jurisdiction override. */ public $taxRegionId; - /** * @var string The boundary level of this override (See BoundaryLevel::* for a list of allowable values) */ public $boundaryLevel; - /** * @var boolean True if this is a default boundary */ public $isDefault; - } - /** * Represents information about a single legal taxing jurisdiction */ class JurisdictionModel { - /** * @var string The code that is used to identify this jurisdiction */ public $code; - /** * @var string The name of this jurisdiction */ public $name; - /** * @var string The type of the jurisdiction, indicating whether it is a country, state/region, city, for example. (See JurisdictionType::* for a list of allowable values) */ public $type; - /** * @var float The base rate of tax specific to this jurisdiction. */ public $rate; - /** * @var float The "Sales" tax rate specific to this jurisdiction. */ public $salesRate; - /** * @var string The Avalara-supplied signature code for this jurisdiction. */ public $signatureCode; - /** * @var string 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`. */ public $region; - /** * @var float The "Seller's Use" tax rate specific to this jurisdiction. */ public $useRate; - /** * @var string The city name of this jurisdiction */ public $city; - /** * @var string The county name of this jurisdiction */ public $county; - /** * @var string Name or ISO 3166 code identifying the country of this jurisdiction. 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`. */ public $country; - /** * @var string A short name of the jurisidiction */ public $shortName; - /** * @var string State FIPS code */ public $stateFips; - /** * @var string County FIPS code */ public $countyFips; - /** * @var string City FIPS code */ public $placeFips; - /** * @var int Unique AvaTax Id of this Jurisdiction */ public $id; - /** * @var string The date this jurisdiction starts to take effect on tax calculations */ public $effectiveDate; - /** * @var string The date this jurisdiction stops to take effect on tax calculations */ public $endDate; - } - /** * Resource File Type Model */ class ResourceFileTypeModel { - /** * @var int The resource file type id */ public $resourceFileTypeId; - /** * @var string The name of the file type */ public $name; - } - /** * Rate type Model */ class RateTypeModel { - /** * @var string The unique ID number of this rate type. */ public $id; - /** * @var string Description of this rate type. */ public $description; - /** * @var string Country code for this rate type */ public $country; - } - /** * Represents information about a tax form known to Avalara */ class FormMasterModel { - /** * @var int Unique ID number of this form master object */ public $id; - /** * @var int The type of the form being submitted */ public $formTypeId; - /** * @var string Unique tax form code representing this tax form */ public $taxFormCode; - /** * @var string Legacy return name as known in the AvaFileForm table */ public $legacyReturnName; - /** * @var string Human readable form summary name */ public $taxFormName; - /** * @var string Description of this tax form */ public $description; - /** * @var boolean True if this form is available for use */ public $isEffective; - /** * @var string ISO 3166 code of the country that issued this tax form */ public $country; - /** * @var string The region within which this form was issued */ public $region; - /** * @var string Tax authority that issued the form */ public $authorityName; - /** * @var string DEPRECATED */ public $shortCode; - /** * @var int Day of the month when the form is due */ public $dueDay; - /** * @var int Day of the month on which the form is considered delinquent. Almost always the same as DueDay */ public $delinquentDay; - /** * @var int Month of the year the state considers as the first fiscal month */ public $fiscalYearStartMonth; - /** * @var boolean Can form support multi frequencies */ public $hasMultiFrequencies; - /** * @var boolean Does this tax authority require a power of attorney in order to speak to Avalara */ public $isPOARequired; - /** * @var boolean True if this form requires that the customer register with the authority */ public $isRegistrationRequired; - /** * @var boolean Unused */ public $hasMultiRegistrationMethods; - /** * @var boolean Unused */ public $hasSchedules; - /** * @var boolean Unused */ public $hasMultiFilingMethods; - /** * @var boolean Unused */ public $hasMultiPayMethods; - /** * @var boolean Unused */ public $isEFTRequired; - /** * @var boolean Unused */ public $isFilePayMethodLinked; - /** * @var int Unused */ public $mailingReceivedRuleId; - /** * @var int Unused */ public $proofOfMailingId; - /** * @var boolean True if you can report a negative amount in a single jurisdiction on the form */ public $isNegAmountAllowed; - /** * @var boolean True if the form overall can go negative */ public $allowNegativeOverallTax; - /** * @var boolean Unused */ public $isNettingRequired; - /** * @var int Unused */ public $roundingMethodId; - /** * @var float Total amount of discounts that can be received by a vendor each year */ public $vendorDiscountAnnualMax; - /** * @var boolean Unused */ public $versionsRequireAuthorityApproval; - /** * @var int Type of outlet reporting for this form */ public $outletReportingMethodId; - /** * @var boolean Unused */ public $hasReportingCodes; - /** * @var boolean Not sure if used */ public $hasPrepayments; - /** * @var boolean Unused */ public $grossIncludesInterstateSales; - /** * @var string Unused */ public $grossIncludesTax; - /** * @var boolean Unused */ public $hasEfileFee; - /** * @var boolean Unused */ public $hasEpayFee; - /** * @var boolean Unused */ public $hasDependencies; - /** * @var string Unused */ public $requiredEfileTrigger; - /** * @var string Unused */ public $requiredEftTrigger; - /** * @var boolean Unused */ public $vendorDiscountEfile; - /** * @var boolean Unused */ public $vendorDiscountPaper; - /** * @var string Unused */ public $peerReviewed; - /** * @var string Unused */ public $peerReviewedId; - /** * @var string Unused */ public $peerReviewedDate; - /** * @var int ID of the Avalara user who created the form */ public $createdUserId; - /** * @var string Date when form was created */ public $createdDate; - /** * @var int ID of the Avalara user who modified the form */ public $modifiedUserId; - /** * @var string Date when form was modified */ public $modifiedDate; - /** * @var string Mailing address of the department of revenue */ public $dorAddressMailTo; - /** * @var string Mailing address of the department of revenue */ public $dorAddress1; - /** * @var string Mailing address of the department of revenue */ public $dorAddress2; - /** * @var string Mailing address of the department of revenue */ public $dorAddressCity; - /** * @var string Mailing address of the department of revenue */ public $dorAddressRegion; - /** * @var string Mailing address of the department of revenue */ public $dorAddressPostalCode; - /** * @var string Mailing address of the department of revenue */ public $dorAddressCountry; - /** * @var string Mailing address to use when a zero dollar form is filed */ public $zeroAddressMailTo; - /** * @var string Mailing address to use when a zero dollar form is filed */ public $zeroAddress1; - /** * @var string Mailing address to use when a zero dollar form is filed */ public $zeroAddress2; - /** * @var string Mailing address to use when a zero dollar form is filed */ public $zeroAddressCity; - /** * @var string Mailing address to use when a zero dollar form is filed */ public $zeroAddressRegion; - /** * @var string Mailing address to use when a zero dollar form is filed */ public $zeroAddressPostalCode; - /** * @var string Mailing address to use when a zero dollar form is filed */ public $zeroAddressCountry; - /** * @var string Mailing address to use when filing an amended return */ public $amendedAddressMailTo; - /** * @var string Mailing address to use when filing an amended return */ public $amendedAddress1; - /** * @var string Mailing address to use when filing an amended return */ public $amendedAddress2; - /** * @var string Mailing address to use when filing an amended return */ public $amendedAddressCity; - /** * @var string Mailing address to use when filing an amended return */ public $amendedAddressRegion; - /** * @var string Mailing address to use when filing an amended return */ public $amendedAddressPostalCode; - /** * @var string Mailing address to use when filing an amended return */ public $amendedAddressCountry; - /** * @var boolean Unused */ public $onlineBackFiling; - /** * @var boolean Unused */ public $onlineAmendedReturns; - /** * @var string --Need Further Clarification */ public $prepaymentFrequency; - /** * @var boolean Unused */ public $outletLocationIdentifiersRequired; - /** * @var string --Need Further Clarification */ public $listingSortOrder; - /** * @var string Link to the state department of revenue website, if available */ public $dorWebsite; - /** * @var boolean --Need Further Clarification */ public $fileForAllOutlets; - /** * @var boolean --Need Further Clarification */ public $paperFormsDoNotHaveDiscounts; - /** * @var boolean Internal behavior */ public $stackAggregation; - /** * @var string --Need Further Clarification */ public $roundingPrecision; - /** * @var string --Need Further Clarification */ public $inconsistencyTolerance; - /** * @var string Date when this form became effective */ public $effDate; - /** * @var string Date when this form expired */ public $endDate; - /** * @var boolean True if this form can be shown to customers */ public $visibleToCustomers; - /** * @var boolean True if this form requires that you set up outlets in the state */ public $requiresOutletSetup; - /** * @var boolean True if this state permits payment by ACH Credit */ public $achCreditAllowed; - /** * @var string Jurisdiction level of the state */ public $reportLevel; - /** * @var boolean True if this form is verified filed via email */ public $postOfficeValidated; - /** * @var string Internal Avalara flag */ public $stackAggregationOption; - /** * @var string Internal Avalara flag */ public $sstBehavior; - /** * @var string Internal Avalara flag */ public $nonSstBehavior; - /** * @var string Phone number of the department of revenue */ public $dorPhoneNumber; - /** * @var string Unused */ public $averageCheckClearDays; - /** * @var boolean Unused */ public $filterZeroRatedLineDetails; - /** * @var boolean Unused */ public $allowsBulkFilingAccounts; - /** * @var string Unused */ public $bulkAccountInstructionLink; - /** * @var string Unused */ public $registrationIdFormat; - /** * @var string Unused */ public $thresholdTrigger; - /** * @var string Unused */ public $transactionSortingOption; - /** * @var int Unused */ public $contentReviewFrequencyId; - /** * @var string Unused */ public $aliasForFormMasterId; - } - /** * Represents a tax type group */ class TaxTypeGroupModel { - /** * @var int The unique ID number of this tax type group. */ public $id; - /** * @var string The unique human readable Id of this tax type group. */ public $taxTypeGroup; - /** * @var string The description of this tax type group. */ public $description; - /** * @var int If this tax type group requires a subscription, this contains the ID number of the subscription type required to use it. */ public $subscriptionTypeId; - /** * @var string If this tax type group requires a subscription, this contains the friendly name of the subscription type required to use it. */ public $subscriptionDescription; - /** * @var string The name of the tab in the AvaTax website corresponding to this tax type group. */ public $tabName; - /** * @var boolean True if this tax type group is displayed in the user interface of the AvaTax website. */ public $showColumn; - /** * @var int The order this record is being returned in the response */ public $displaySequence; - } - /** * Represents a tax subtype */ class TaxSubTypeModel { - /** * @var int The unique ID number of this tax sub-type. */ public $id; - /** * @var string The unique human readable Id of this tax sub-type. */ public $taxSubType; - /** * @var string The description of this tax sub-type. */ public $description; - /** * @var string The upper level group of tax types. */ public $taxTypeGroup; - } - /** * Represents a group of tax types */ class NexusTaxTypeGroupModel { - /** * @var int The unique ID number of this nexus tax type group. */ public $id; - /** * @var string The unique human readable Id of this nexus tax type group. */ public $nexusTaxTypeGroupId; - /** * @var string The description of this nexus tax type group. */ public $description; - /** * @var int If this tax type group requires a subscription, this contains the ID number of the subscription type required to use it. */ public $subscriptionTypeId; - /** * @var string If this tax type group requires a subscription, this contains the friendly name of the subscription type required to use it. */ public $subscriptionDescription; - /** * @var string The name of the tab in the AvaTax website corresponding to this tax type group. */ public $tabName; - /** * @var boolean True if this tax type group is displayed in the user interface of the AvaTax website. */ public $showColumn; - } - /** * Represents a transaction/service type pair for telecommunications tax */ class CommunicationsTSPairModel { - /** * @var int The numeric Id of the transaction type. */ public $transactionTypeId; - /** * @var int The numeric Id of the service type. */ public $serviceTypeId; - /** * @var string The name of the transaction type. */ public $AvaTax_Communications_TransactionType; - /** * @var string The name of the service type. */ public $AvaTax_Communications_ServiceType; - /** * @var string The description of the transaction/service type pair. */ public $description; - /** * @var string[] List of the parameters (among Charge, Minutes and Lines) that will be used for calculation for this T/S pair. */ public $requiredParameters; - } - /** * Represents information about a type of telecommunications transaction */ class CommunicationsTransactionTypeModel { - /** * @var int The numeric Id of the transaction type. */ public $transactionTypeId; - /** * @var string The name of the transaction type. */ public $AvaTax_Communications_TransactionType; - } - /** * The "Unit of Measurement" model captures information about a type of measurement. Types of measurement refer to * different scales for the same dimension. For example, measurements of type "Distance" may include units of measurement @@ -8578,54 +6825,43 @@ class CommunicationsTransactionTypeModel */ class UomModel { - /** * @var int The unique ID number of this unit of measurement. */ public $id; - /** * @var string The code that refers to this unit of measurement. */ public $code; - /** * @var string A short description of this unit of measurement. */ public $shortDesc; - /** * @var string A longer description of this unit of measurement. */ public $description; - /** * @var int The ID number of the measurement type, such as "Distance" or "Mass". */ public $measurementTypeId; - /** * @var string The code describing the measurement type. */ public $measurementTypeCode; - /** * @var string For a particular measurement type, this is the ID number of the unit of measurement object corresponding to the International System of Units (abbreviated SI) unit of measurement standard. This pointer allows you to select the SI unit of measurement for a particular measurement type. */ public $siUOM; - /** * @var string A description of the measurement type system. */ public $measurementTypeDescription; - /** * @var boolean True if this measurement is an International System of Units (abbreviated SI) defined standard. */ public $isSiUom; - } - /** * Describes an element in the harmonized tariff system. * @@ -8641,145 +6877,115 @@ class UomModel */ class HsCodeModel { - /** * @var string The harmonized tariff system code for this section and chapter. A full HS code contains more than six characters. Partial HS codes with two, four, or six characters may have child codes underneath them. A child code is one that contains greater specificity than a parent code. It is recommended that when you identify a product you use the most detailed code available to identify it. Top level sections do not have HS Codes. */ public $hsCode; - /** * @var int A unique identifier for this harmonized tariff system code. To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value. */ public $id; - /** * @var int The unique ID number of the parent HS code or HS code prefix. To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value. */ public $parentHsCodeId; - /** * @var string A human readable description that identifies Code descriptive text for this Section, Chapter, Heading, or Subheading. */ public $description; - /** * @var string The system to which this HS code belongs. */ public $system; - /** * @var string The destination country identified with this HS Code. This value applies when certain products are classified in specific ways by bilateral trade agreements. */ public $destinationCountry; - /** * @var string For codes that have been expired or defined on specific dates, this value indicates the earliest date for which this code is considered valid. If this value is null, this code can be used for any valid date earlier than its end date. */ public $effDate; - /** * @var string For codes that have been expired or defined on specific dates, this value indicates the latest date for which this code is considered valid. If this value is null, this code can be used for any valid date later than its effective date. */ public $endDate; - } - /** * Represents a PostalCode and its associated data like: country, region, effective dates, etc. */ class PostalCodeModel { - /** * @var string Country this PostalCode locates in */ public $country; - /** * @var string The Region/State/Province this PostalCode locates in */ public $region; - /** * @var int An Avalara assigned TaxRegion Id associated to the PostalCode */ public $taxRegionId; - /** * @var string The date when the PostalCode becomes effective */ public $effDate; - /** * @var string The date when the PostalCode becomes expired */ public $endDate; - /** * @var string The postalCode */ public $postalCode; - } - /** * Marketplace Location Output model */ class MarketplaceLocationModel { - /** * @var string Marketplace Location State */ public $region; - /** * @var string Marketplace Location Country */ public $country; - /** * @var string Marketplace Location Id */ public $marketplaceId; - /** * @var string Marketplace Location */ public $marketplace; - /** * @var string Marketplace Location Adoption Date */ public $marketplaceAdoptionDate; - /** * @var string Marketplace Location End Date */ public $marketplaceEndDate; - /** * @var string Marketplace Location Legislative Effective Date */ public $legislativeEffectiveDate; - /** * @var string Marketplace Location Enforcement Date */ public $enforcementDate; - /** * @var string Marketplace Location Created Date */ public $createdDate; - /** * @var string Marketplace Location Modified Date */ public $modifiedDate; - } - /** * A company-distance-threshold model indicates the distance between a company * and the taxing borders of various countries. Distance thresholds are necessary @@ -8801,3008 +7007,2384 @@ class MarketplaceLocationModel */ class CompanyDistanceThresholdModel { - /** * @var int A unique ID number representing this distance threshold object. */ public $id; - /** * @var int The ID number of the company that defined this distance threshold. */ public $companyId; - /** * @var string The origin country for this threshold. 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`. */ public $originCountry; - /** * @var string The destination country for this threshold. 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`. */ public $destinationCountry; - /** * @var string For distance threshold values that change over time, this is the earliest date for which this distance threshold is valid. If null, this distance threshold is valid for all dates earlier than the `endDate` field. */ public $effDate; - /** * @var string For distance threshold values that change over time, this is the latest date for which this distance threshold is valid. If null, this distance threshold is valid for all dates later than the `effDate` field. */ public $endDate; - /** * @var boolean True if your tax professional has determined that the value-added tax distance threshold is exceeded for this pair of countries. If you set this value to `false`, your value added taxes will be calculated using the origin country. Otherwise, value added taxes will be calculated on the destination country. */ public $thresholdExceeded; - /** * @var string Indicates the distance threshold type. This value can be either `Sale` or `Purchase`. */ public $type; - } - /** * */ -class CappedFetchResult[ErrorTransactionOutputModel] +class CappedFetchResult { - /** * @var boolean */ public $_isRecordsetCountCapped; - /** * @var int */ public $_recordsetCount; - /** - * @var ErrorTransactionOutputModel[] + * @var object[] */ public $value; - /** * @var string */ public $_nextLink; - /** * @var string */ public $pageKey; - } - /** * Error Transaction Model */ class ErrorTransactionOutputModel { - /** * @var string Error code of the error result from transaction creation */ public $errorCode; - /** * @var string Error message of the error result from transaction creation */ public $errorMessage; - /** * @var string The full JSON of the error result from transaction creation */ public $avataxErrorJson; - /** * @var string The full JSON of the transaction creation request */ public $avataxCreateTransactionJson; - /** * @var string The datasource instance that made the transaction creation call */ public $datasource; - /** * @var string The date of the document */ public $documentDate; - /** * @var string The date that this ErrorTransaction will be automatically purged from the detabase. */ public $expiresAt; - /** * @var float The amount of the transaction. */ public $amount; - /** * @var string The Datasource source of the transaction creation call. */ public $datasourceSource; - /** * @var string The country of the ship to address for the transaction creation call. */ public $shipToCountry; - /** * @var string The region of the ship to address for the transaction creation call. */ public $shipToRegion; - /** * @var string Type of transaction of the error transaction (See DocumentType::* for a list of allowable values) */ public $documentType; - /** * @var string The internal reference code (used by the client application) of the error transaction */ public $documentCode; - } - /** * Request model for when a user is deleting multiple error transaction */ class DeleteErrorTransactionsRequestModel { - /** * @var ErrorTransactionModelBase[] List of error transactions to be deleted */ public $models; - } - /** * Base model class for single error transaction delete request */ class ErrorTransactionModelBase { - /** * @var string Type of transaction of the error transaction (See DocumentType::* for a list of allowable values) */ public $documentType; - /** * @var string The internal reference code (used by the client application) of the error transaction */ public $documentCode; - } - /** * Response model of error transaction batch delete */ class DeleteErrorTransactionsResponseModel { - /** * @var DeleteErrorTransactionResponseModel[] The individual result of each error transaction in the request batch */ public $results; - } - /** * Response model of a single error transaction delete */ class DeleteErrorTransactionResponseModel { - /** * @var string Result of the deletion (See AvataxDeleteErrorTransactionStatus::* for a list of allowable values) */ public $result; - /** * @var string Type of transaction of the error transaction (See DocumentType::* for a list of allowable values) */ public $documentType; - /** * @var string The internal reference code (used by the client application) of the error transaction */ public $documentCode; - } - /** * */ -class CappedFetchResult[ErrorCodeOutputModel] +class CappedFetchResult { - /** * @var boolean */ public $_isRecordsetCountCapped; - /** * @var int */ public $_recordsetCount; - /** - * @var ErrorCodeOutputModel[] + * @var object[] */ public $value; - /** * @var string */ public $_nextLink; - /** * @var string */ public $pageKey; - } - /** * Model that has the matching count for an errorcode */ class ErrorCodeOutputModel { - /** * @var string Name of the error code */ public $errorCode; - /** * @var int Number of error code recorded */ public $count; - } - /** * Represents a commitment to file a tax return on a recurring basis. * Only used if you subscribe to Avalara Returns. */ class FilingCalendarModel { - /** * @var int The unique ID number of this filing calendar. */ public $id; - /** * @var int The unique ID number of the company to which this filing calendar belongs. */ public $companyId; - /** * @var string DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead. The legacy return name of the tax form to file. */ public $returnName; - /** * @var string Name or ISO 3166 code identifying the country that issued the tax form for this filing calendar. 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`. */ public $formCountry; - /** * @var string Name or ISO 3166 code identifying the region that issued the tax form for this filing calendar. 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`. */ public $formRegion; - /** * @var string The Avalara standard tax form code of the tax form for this filing calendar. The first two characters of the tax form code are the ISO 3166 country code of the country that issued this form. */ public $taxFormCode; - /** * @var int The start period of a fiscal year for this form/company */ public $fiscalYearStartMonth; - /** * @var string If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL. */ public $locationCode; - /** * @var string If this calendar is for a location-specific tax return, specify the location-specific behavior here. (See OutletTypeId::* for a list of allowable values) */ public $outletTypeId; - /** * @var string Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD". */ public $paymentCurrency; - /** * @var string The frequency on which this tax form is filed. (See FilingFrequencyId::* for a list of allowable values) */ public $filingFrequencyId; - /** * @var int A 16-bit bitmap containing a 1 for each month when the return should be filed. */ public $months; - /** * @var string Tax Registration ID for this Region - in the U.S., this is for your state. */ public $stateRegistrationId; - /** * @var string Tax Registration ID for the local jurisdiction, if any. */ public $localRegistrationId; - /** * @var string The Employer Identification Number or Taxpayer Identification Number that is to be used when filing this return. */ public $employerIdentificationNumber; - /** * @var string DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The first line of the mailing address that will be used when filling out this tax return. */ public $line1; - /** * @var string DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The second line of the mailing address that will be used when filling out this tax return. Please note that some tax forms do not support multiple address lines. */ public $line2; - /** * @var string DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The city name of the mailing address that will be used when filling out this tax return. */ public $city; - /** * @var string DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The state, region, or province of the mailing address that will be used when filling out this tax return. */ public $region; - /** * @var string DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The postal code or zip code of the mailing address that will be used when filling out this tax return. */ public $postalCode; - /** * @var string DEPRECATED - Date: 9/1/2017, Version: 17.9, Message: Field will be no longer be available after the 17.9 release. The two character ISO-3166 country code of the mailing address that will be used when filling out this tax return. */ public $country; - /** * @var string The first line of the mailing address that will be used when filling out this tax return. */ public $mailingAddressLine1; - /** * @var string The second line of the mailing address that will be used when filling out this tax return. Please note that some tax forms do not support multiple address lines. */ public $mailingAddressLine2; - /** * @var string The city name of the mailing address that will be used when filling out this tax return. */ public $mailingAddressCity; - /** * @var string Name or ISO 3166 code identifying the region of the mailing address that will be used when filling out this tax return. 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`. */ public $mailingAddressRegion; - /** * @var string The postal code or zip code of the mailing address that will be used when filling out this tax return. */ public $mailingAddressPostalCode; - /** * @var string Name or ISO 3166 code identifying the country of the mailing address that will be used when filling out this tax return. 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`. */ public $mailingAddressCountry; - /** * @var string The phone number to be used when filing this return. */ public $phone; - /** * @var string Special filing instructions to be used when filing this return. Please note that requesting special filing instructions may incur additional costs. */ public $customerFilingInstructions; - /** * @var string The legal entity name to be used when filing this return. */ public $legalEntityName; - /** * @var string The earliest date for the tax period when this return should be filed. This date specifies the earliest date for tax transactions that should be reported on this filing calendar. Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February. */ public $effectiveDate; - /** * @var string The last date for the tax period when this return should be filed. This date specifies the last date for tax transactions that should be reported on this filing calendar. Please note that tax is usually filed one month in arrears: for example, tax for January transactions is typically filed during the month of February. */ public $endDate; - /** * @var string The method to be used when filing this return. (See FilingTypeId::* for a list of allowable values) */ public $filingTypeId; - /** * @var string If you file electronically, this is the username you use to log in to the tax authority's website. */ public $eFileUsername; - /** * @var string If you file electronically, this is the password or pass code you use to log in to the tax authority's website. */ public $eFilePassword; - /** * @var int If you are required to prepay a percentage of taxes for future periods, please specify the percentage in whole numbers; for example, the value 90 would indicate 90%. */ public $prepayPercentage; - /** * @var boolean Determines if a prepayment is required for this filing calendar */ public $prePaymentRequired; - /** * @var float If your company is required to make a prepayment that is designated by a fixed amount each period, please specify the amount here. */ public $fixedPrepaymentAmount; - /** * @var string The type of tax to report on this return. (See MatchingTaxType::* for a list of allowable values) */ public $taxTypeId; - /** * @var string Internal filing notes. */ public $internalNotes; - /** * @var string Custom filing information field for Alabama. */ public $alSignOn; - /** * @var string Custom filing information field for Alabama. */ public $alAccessCode; - /** * @var string Custom filing information field for Maine. */ public $meBusinessCode; - /** * @var string Custom filing information field for Iowa. */ public $iaBen; - /** * @var string Custom filing information field for Connecticut. */ public $ctReg; - /** * @var string Custom filing information field. Leave blank. */ public $other1Name; - /** * @var string Custom filing information field. Leave blank. */ public $other1Value; - /** * @var string Custom filing information field. Leave blank. */ public $other2Name; - /** * @var string Custom filing information field. Leave blank. */ public $other2Value; - /** * @var string Custom filing information field. Leave blank. */ public $other3Name; - /** * @var string Custom filing information field. Leave blank. */ public $other3Value; - /** * @var int The unique ID of the tax authority of this return. */ public $taxAuthorityId; - /** * @var string The name of the tax authority of this return. */ public $taxAuthorityName; - /** * @var string The type description of the tax authority of this return. */ public $taxAuthorityType; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var string User name of bulk account. */ public $bulkAccountId; - /** * @var string The bulk account site code. */ public $siteCode; - /** * @var string The status of the bulk account's validation. (See BulkAccountValidationStatus::* for a list of allowable values) */ public $bulkAccountValidationStatus; - /** * @var CompanyReturnSettingModel[] CompanyReturn settings for complext filing calendar */ public $settings; - } - /** * */ class CompanyReturnSettingModel { - /** * @var int The unique ID of this CompanyReturnsSetting */ public $id; - /** * @var int The CompanyReturn Id */ public $companyReturnId; - /** * @var int The TaxFormCatalog filingQuestionId. */ public $filingQuestionId; - /** * @var string Filing question code as defined in TaxFormCatalog. */ public $filingQuestionCode; - /** * @var string The value of this setting */ public $value; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Represents a complex query request to parse using query filter guidelines from Microsoft REST standards */ class QueryRequestModel { - /** * @var string A list of conditions to filter objects. */ public $filter; - /** * @var string A list of included commands for this fetch operation. */ public $include; - /** * @var int For pagination: This is the maximum number of results to return. */ public $maxResults; - /** * @var int For pagination: This is the index of the first result. */ public $startIndex; - /** * @var string Sorts the resulting objects in a specific manner. */ public $sortBy; - } - /** * Model with options for adding a new filing calendar */ class CycleAddOptionModel { - /** * @var boolean True if this form can be added and filed for the current cycle. "Current cycle" is considered one month before the month of today's date. */ public $available; - /** * @var string The period start date for the customer's first transaction in the jurisdiction being added */ public $transactionalPeriodStart; - /** * @var string The period end date for the customer's last transaction in the jurisdiction being added */ public $transactionalPeriodEnd; - /** * @var string The jurisdiction-assigned due date for the form */ public $filingDueDate; - /** * @var string A descriptive name of the cycle and due date of form. */ public $cycleName; - /** * @var string The filing frequency of the form */ public $frequencyName; - /** * @var string A code assigned to the filing frequency */ public $filingFrequencyCode; - /** * @var string The filing frequency of the request (See FilingFrequencyId::* for a list of allowable values) */ public $filingFrequencyId; - /** * @var string An explanation for why this form cannot be added for the current cycle */ public $cycleUnavailableReason; - /** * @var string[] A list of outlet codes that can be assigned to this form for the current cycle */ public $availableLocationCodes; - } - /** * Cycle Safe Expiration results. */ class CycleExpireModel { - /** * @var boolean Whether or not the filing calendar can be expired. e.g. if user makes end date of a calendar earlier than latest filing, this would be set to false. */ public $success; - /** * @var string The message to present to the user if expiration is successful or unsuccessful. */ public $message; - /** * @var CycleExpireOptionModel[] A list of options for expiring the filing calendar. */ public $cycleExpirationOptions; - } - /** * Options for expiring a filing calendar. */ class CycleExpireOptionModel { - /** * @var string The period start date for the customer's first transaction in the jurisdiction being expired. */ public $transactionalPeriodStart; - /** * @var string The period end date for the customer's last transaction in the jurisdiction being expired. */ public $transactionalPeriodEnd; - /** * @var string The jurisdiction-assigned due date for the form. */ public $filingDueDate; - /** * @var string A descriptive name of the cycle and due date of the form. */ public $cycleName; - } - /** * An edit to be made on a filing calendar. */ class FilingCalendarEditModel { - /** * @var string The name of the field to be modified. */ public $fieldName; - /** * @var int The unique ID of the filing calendar question. "Filing calendar question" is the wording displayed to users for a given field. */ public $questionId; - /** * @var object The current value of the field. */ public $oldValue; - /** * @var object The new/proposed value of the field. */ public $newValue; - } - /** * Model with options for actual filing calendar output based on user edits to filing calendar. */ class CycleEditOptionModel { - /** * @var boolean Whether or not changes can be made to the filing calendar. */ public $success; - /** * @var string The message to present to the user when calendar is successfully or unsuccessfully changed. */ public $message; - /** * @var boolean Whether or not the user should be warned of a change, because some changes are risky and may be being done not in accordance with jurisdiction rules. For example, user would be warned if user changes filing frequency to new frequency with a start date during an accrual month of the existing frequency. */ public $customerMustApprove; - /** * @var boolean True if the filing calendar must be cloned to allow this change; false if the existing filing calendar can be changed itself. */ public $mustCloneFilingCalendar; - /** * @var string The effective date of the filing calendar (only applies if cloning). */ public $clonedCalendarEffDate; - /** * @var string The expired end date of the old filing calendar (only applies if cloning). */ public $expiredCalendarEndDate; - } - /** * Represents a commitment to file a tax return on a recurring basis. * Only used if you subscribe to Avalara Returns. */ class FilingRequestModel { - /** * @var int The unique ID number of this filing request. */ public $id; - /** * @var int The unique ID number of the company to which this filing request belongs. */ public $companyId; - /** * @var string The current status of this request (See FilingRequestStatus::* for a list of allowable values) */ public $filingRequestStatusId; - /** * @var FilingRequestDataModel The data model object of the request */ public $data; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Represents a commitment to file a tax return on a recurring basis. * Only used if you subscribe to Avalara Returns. */ class FilingRequestDataModel { - /** * @var int The company return ID if requesting an update. */ public $companyReturnId; - /** * @var string DEPRECATED - Date: 9/13/2018, Version: 18.10, Message: Please use `taxFormCode` instead. The legacy return name of the requested calendar. */ public $returnName; - /** * @var string The Avalara standard tax form code of the tax form for this filing calendar. The first two characters of the tax form code are the ISO 3166 country code of the country that issued this form. */ public $taxFormCode; - /** * @var string The filing frequency of the request (See FilingFrequencyId::* for a list of allowable values) */ public $filingFrequencyId; - /** * @var string State registration ID of the company requesting the filing calendar. */ public $registrationId; - /** * @var int The months of the request */ public $months; - /** * @var int The start period of a fiscal year for this form/company */ public $fiscalYearStartMonth; - /** * @var string The type of tax to report on this return. (See MatchingTaxType::* for a list of allowable values) */ public $taxTypeId; - /** * @var string Location code of the request */ public $locationCode; - /** * @var string Filing cycle effective date of the request */ public $effDate; - /** * @var string Filing cycle end date of the request */ public $endDate; - /** * @var boolean Flag if the request is a clone of a current filing calendar */ public $isClone; - /** * @var string The two character ISO 3166 country code of the country that issued the tax form for this filing calendar. */ public $country; - /** * @var string The two or three character ISO 3166 code of the region / state / province that issued the tax form for this filing calendar. */ public $region; - /** * @var int The tax authority id of the return */ public $taxAuthorityId; - /** * @var string The tax authority name on the return */ public $taxAuthorityName; - /** * @var FilingAnswerModel[] Filing question answers */ public $answers; - } - /** * */ class FilingAnswerModel { - /** * @var int The ID number for a filing question */ public $filingQuestionId; - /** * @var object The value of the answer for the filing question identified by filingQuestionId */ public $answer; - } - /** * This is the output model coming from skyscraper services */ class LoginVerificationOutputModel { - /** * @var int The job Id returned from skyscraper */ public $jobId; - /** * @var string The operation status of the job */ public $operationStatus; - /** * @var string The message returned from the job */ public $message; - /** * @var boolean Indicates if the login was successful */ public $loginSuccess; - } - /** * Represents a verification request using Skyscraper for a company */ class LoginVerificationInputModel { - /** * @var int CompanyId that we are verifying the login information for */ public $companyId; - /** * @var int AccountId of the login verification */ public $accountId; - /** * @var string Region of the verification request */ public $region; - /** * @var string TaxFormCode for the verification request */ public $taxFormCode; - /** * @var string Username that we are using for verification */ public $username; - /** * @var string Password we are using for verification */ public $password; - /** * @var object Additional options of the verification */ public $additionalOptions; - /** * @var int Bulk Request Id of the verification */ public $bulkRequestId; - /** * @var int Priority of the verification request */ public $priority; - } - /** * Response when checking if a company has a POA on file with Avalara */ class PowerOfAttorneyCheckModel { - /** * @var int companyId of the request */ public $companyId; - /** * @var string Country POA is for */ public $country; - /** * @var string Region POA is for */ public $region; - /** * @var boolean Notes if there is an actice POA */ public $activePoa; - /** * @var string Effective Date of the POA */ public $effectiveDate; - /** * @var string End Date of POA */ public $expirationDate; - /** * @var ResourceFileDownloadResult POA download */ public $availablePoa; - } - /** * Represents everything downloaded from resource files */ class ResourceFileDownloadResult { - /** * @var boolean True if this download succeeded */ public $success; - /** * @var int Bytes of the file */ public $bytes; - /** * @var string Original filename */ public $filename; - /** * @var string Mime content type */ public $contentType; - } - /** * Filing Returns Model */ class FilingReturnModelBasic { - /** * @var int The unique ID number of the company filing return. */ public $companyId; - /** * @var int The unique ID number of this filing return. */ public $id; - /** * @var int The filing id that this return belongs too */ public $filingId; - /** * @var int The resourceFileId of the return */ public $resourceFileId; - /** * @var int The region id that this return belongs too */ public $filingRegionId; - /** * @var int The unique ID number of the filing calendar associated with this return. */ public $filingCalendarId; - /** * @var string The country of the form. */ public $country; - /** * @var string The region of the form. */ public $region; - /** * @var int The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $endPeriodMonth; - /** * @var int The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $endPeriodYear; - /** * @var string The current status of the filing return. (See FilingStatusId::* for a list of allowable values) */ public $status; - /** * @var string The filing frequency of the return. (See FilingFrequencyId::* for a list of allowable values) */ public $filingFrequency; - /** * @var string The date the return was filed by Avalara. */ public $filedDate; - /** * @var float The sales amount. */ public $salesAmount; - /** * @var string The filing type of the return. (See FilingTypeId::* for a list of allowable values) */ public $filingType; - /** * @var string The name of the form. */ public $formName; - /** * @var float The remittance amount of the return. */ public $remitAmount; - /** * @var string The unique code of the form. */ public $formCode; - /** * @var string A description for the return. */ public $description; - /** * @var float The taxable amount. */ public $taxableAmount; - /** * @var float The tax amount. */ public $taxAmount; - /** * @var float The amount collected by avalara for this return */ public $collectAmount; - /** * @var float The tax due amount. */ public $taxDueAmount; - /** * @var float The non-taxable amount. */ public $nonTaxableAmount; - /** * @var float The non-taxable due amount. */ public $nonTaxableDueAmount; - /** * @var float Consumer use tax liability. */ public $consumerUseTaxAmount; - /** * @var float Consumer use non-taxable amount. */ public $consumerUseNonTaxableAmount; - /** * @var float Consumer use taxable amount. */ public $consumerUseTaxableAmount; - /** * @var float The amount of sales excluded from the liability calculation */ public $excludedSalesAmount; - /** * @var float The amount of non-taxable sales excluded from the liability calculation */ public $excludedNonTaxableAmount; - /** * @var float The amount of tax excluded from the liability calculation */ public $excludedTaxAmount; - /** * @var string Accrual type of the return (See AccrualType::* for a list of allowable values) */ public $accrualType; - /** * @var FilingAttachmentModel[] The attachments for this return. */ public $attachments; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - } - /** * An attachment associated with a filing return */ class FilingAttachmentModel { - /** * @var int The resourceFileId used to retrieve the attachment */ public $resourceFileId; - /** * @var string The description of the attachment */ public $description; - } - /** * Filing Returns Model */ class FiledReturnModel { - /** * @var int The unique ID number of the company filing return. */ public $companyId; - /** * @var int The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $endPeriodMonth; - /** * @var int The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $endPeriodYear; - /** * @var string The unique code of the form. */ public $taxformCode; - } - /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. */ class FilingModel { - /** * @var int The unique ID number of this filing. */ public $id; - /** * @var int The unique ID number of the company for this filing. */ public $companyId; - /** * @var int The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $month; - /** * @var int The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $year; - /** * @var string Indicates whether this is an original or an amended filing. (See WorksheetTypeId::* for a list of allowable values) */ public $type; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var FilingRegionModel[] A listing of regional tax filings within this time period. */ public $filingRegions; - } - /** * Regions */ class FilingRegionModel { - /** * @var int The unique ID number of this filing region. */ public $id; - /** * @var int The filing id that this region belongs too */ public $filingId; - /** * @var string The two-character ISO-3166 code for the country. */ public $country; - /** * @var string The two or three character region code for the region. */ public $region; - /** * @var float The sales amount. */ public $salesAmount; - /** * @var float The taxable amount. */ public $taxableAmount; - /** * @var float The tax amount. */ public $taxAmount; - /** * @var float The tax amount due. */ public $taxDueAmount; - /** * @var float The amount collected by Avalara for this region */ public $collectAmount; - /** * @var float Total remittance amount of all returns in region */ public $totalRemittanceAmount; - /** * @var float The non-taxable amount. */ public $nonTaxableAmount; - /** * @var float Consumer use tax liability. */ public $consumerUseTaxAmount; - /** * @var float Consumer use non-taxable amount. */ public $consumerUseNonTaxableAmount; - /** * @var float Consumer use taxable amount. */ public $consumerUseTaxableAmount; - /** * @var string The date the filing region was approved. */ public $approveDate; - /** * @var string The start date for the filing cycle. */ public $startDate; - /** * @var string The end date for the filing cycle. */ public $endDate; - /** * @var boolean Whether or not you have nexus in this region. */ public $hasNexus; - /** * @var string The current status of the filing region. (See FilingStatusId::* for a list of allowable values) */ public $status; - /** * @var FilingReturnModel[] A list of tax returns in this region. */ public $returns; - /** * @var FilingsCheckupSuggestedFormModel[] A list of tax returns in this region. */ public $suggestReturns; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Filing Returns Model */ class FilingReturnModel { - /** * @var int The unique ID number of this filing return. */ public $id; - /** * @var int The region id that this return belongs too */ public $filingRegionId; - /** * @var int The unique ID number of the filing calendar associated with this return. */ public $filingCalendarId; - /** * @var int The resourceFileId of the return. Will be null if not available. */ public $resourceFileId; - /** * @var int Tax Authority ID of this return */ public $taxAuthorityId; - /** * @var string The current status of the filing return. (See FilingStatusId::* for a list of allowable values) */ public $status; - /** * @var string The filing frequency of the return. (See FilingFrequencyId::* for a list of allowable values) */ public $filingFrequency; - /** * @var string The date the return was filed by Avalara. */ public $filedDate; - /** * @var string The start date of this return */ public $startPeriod; - /** * @var string The end date of this return */ public $endPeriod; - /** * @var float The sales amount. */ public $salesAmount; - /** * @var string The filing type of the return. (See FilingTypeId::* for a list of allowable values) */ public $filingType; - /** * @var string The name of the form. */ public $formName; - /** * @var float The remittance amount of the return. */ public $remitAmount; - /** * @var string The unique code of the form. */ public $formCode; - /** * @var string A description for the return. */ public $description; - /** * @var float The taxable amount. */ public $taxableAmount; - /** * @var float The tax amount. */ public $taxAmount; - /** * @var float The amount collected by avalara for this return */ public $collectAmount; - /** * @var float The tax due amount. */ public $taxDueAmount; - /** * @var float The non-taxable amount. */ public $nonTaxableAmount; - /** * @var float The non-taxable due amount. */ public $nonTaxableDueAmount; - /** * @var float Consumer use tax liability during the period. */ public $consumerUseTaxAmount; - /** * @var float Consumer use tax liability accrued during the period. */ public $consumerUseTaxDueAmount; - /** * @var float Consumer use non-taxable amount. */ public $consumerUseNonTaxableAmount; - /** * @var float Consumer use taxable amount. */ public $consumerUseTaxableAmount; - /** * @var float Total amount of adjustments on this return */ public $totalAdjustments; - /** * @var float The amount of sales excluded from the liability calculation */ public $excludedSalesAmount; - /** * @var float The amount of non-taxable sales excluded from the liability calculation */ public $excludedNonTaxableAmount; - /** * @var float The amount of tax excluded from the liability calculation */ public $excludedTaxAmount; - /** * @var float The amount of carry over sales applied to the liability calculation */ public $carryOverSalesAmount; - /** * @var float The amount of carry over non taxable sales applied to the liability calculation */ public $carryOverNonTaxableAmount; - /** * @var float The amount of carry over sales tax applied to the liability calculation */ public $carryOverTaxAmount; - /** * @var float The amount of carry over consumer use tax applied to the liability calculation */ public $carryOverConsumerUseTaxAmount; - /** * @var float The total amount of total tax accrued in the current active period */ public $taxAccrualAmount; - /** * @var float The total amount of sales accrued in the current active period */ public $salesAccrualAmount; - /** * @var float The total amount of nontaxable sales accrued in the current active period */ public $nonTaxableAccrualAmount; - /** * @var float The total amount of taxable sales accrued in the current active period */ public $taxableAccrualAmount; - /** * @var float The total amount of sales tax accrued in the current active period */ public $salesTaxAccrualAmount; - /** * @var float The total amount of sellers use tax accrued in the current active period */ public $sellersUseTaxAccrualAmount; - /** * @var float The total amount of consumer use tax accrued in the current active period */ public $consumerUseTaxAccrualAmount; - /** * @var float The total amount of consumer use taxable sales accrued in the current active period */ public $consumerUseTaxableAccrualAmount; - /** * @var float The total amount of consumer use non taxable sales accrued in the current active period */ public $consumerUseNonTaxableAccrualAmount; - /** * @var FilingAdjustmentModel[] The Adjustments for this return. */ public $adjustments; - /** * @var float Total amount of augmentations on this return */ public $totalAugmentations; - /** * @var FilingAugmentationModel[] The Augmentations for this return. */ public $augmentations; - /** * @var float Total amount of payments on this return */ public $totalPayments; - /** * @var FilingPaymentModel[] The payments for this return. */ public $payments; - /** * @var string Accrual type of the return (See AccrualType::* for a list of allowable values) */ public $accrualType; - /** * @var int The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $month; - /** * @var int The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $year; - /** * @var FilingAttachmentModel[] The attachments for this return. */ public $attachments; - /** * @var FilingReturnCreditModel The excluded carry over credit documents */ public $excludedCarryOverCredits; - /** * @var FilingReturnCreditModel The applied carry over credit documents */ public $appliedCarryOverCredits; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - } - /** * Worksheet Checkup Report Suggested Form Model */ class FilingsCheckupSuggestedFormModel { - /** * @var int Tax Authority ID of the suggested form returned */ public $taxAuthorityId; - /** * @var string Country of the suggested form returned */ public $country; - /** * @var string Region of the suggested form returned */ public $region; - /** * @var string Name of the suggested form returned */ public $taxFormCode; - /** * @var string Legacy Name of the suggested form returned */ public $returnName; - } - /** * A model for return adjustments. */ class FilingAdjustmentModel { - /** * @var int The unique ID number for the adjustment. */ public $id; - /** * @var int The filing return id that this applies too */ public $filingId; - /** * @var float The adjustment amount. */ public $amount; - /** * @var string The filing period the adjustment is applied to. (See AdjustmentPeriodTypeId::* for a list of allowable values) */ public $period; - /** * @var string The type of the adjustment. */ public $type; - /** * @var boolean Whether or not the adjustment has been calculated. */ public $isCalculated; - /** * @var string The account type of the adjustment. (See PaymentAccountTypeId::* for a list of allowable values) */ public $accountType; - /** * @var string A descriptive reason for creating this adjustment. */ public $reason; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * A model for return augmentations. */ class FilingAugmentationModel { - /** * @var int The unique ID number for the augmentation. */ public $id; - /** * @var int The filing return id that this applies too */ public $filingId; - /** * @var float The field amount. */ public $fieldAmount; - /** * @var string The field name. */ public $fieldName; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * A model for return payments. */ class FilingPaymentModel { - /** * @var int The unique ID number for the payment. */ public $id; - /** * @var int The filing return id that this applies too */ public $filingId; - /** * @var float The payment amount. */ public $paymentAmount; - /** * @var string The type of the payment. (See PaymentType::* for a list of allowable values) */ public $type; - /** * @var boolean Whether or not the payment has been calculated. */ public $isCalculated; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * An attachment associated with a filing return */ class FilingReturnCreditModel { - /** * @var float The resourceFileId used to retrieve the attachment */ public $totalSales; - /** * @var float The resourceFileId used to retrieve the attachment */ public $totalExempt; - /** * @var float The resourceFileId used to retrieve the attachment */ public $totalTaxable; - /** * @var float The resourceFileId used to retrieve the attachment */ public $totalTax; - /** * @var WorksheetDocument[] The excluded carry over credit documents */ public $transactionDetails; - } - /** * */ 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; - } - /** * */ 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; - } - /** * */ 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; - } - /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. */ class MultiTaxFilingModel { - /** * @var int The unique ID number of this filing. */ public $id; - /** * @var int The unique ID number of the company for this filing. */ public $companyId; - /** * @var int The month of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $month; - /** * @var int The year of the filing period for this tax filing. The filing period represents the year and month of the last day of taxes being reported on this filing. For example, an annual tax filing for Jan-Dec 2015 would have a filing period of Dec 2015. */ public $year; - /** * @var string Indicates whether this is an original or an amended filing. (See WorksheetTypeId::* for a list of allowable values) */ public $type; - /** * @var FilingsTaxSummaryModel A summary of all taxes combined for this period */ public $taxSummary; - /** * @var FilingsTaxDetailsModel[] A detailed breakdown of the taxes in this filing */ public $taxDetails; - /** * @var MultiTaxFilingRegionModel[] A listing of regional tax filings within this time period. */ public $filingRegions; - } - /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. */ class FilingsTaxSummaryModel { - /** * @var float The total sales amount */ public $salesAmount; - /** * @var float The taxable amount */ public $taxableAmount; - /** * @var float The nontaxable amount */ public $nonTaxableAmount; - /** * @var float The tax amount */ public $taxAmount; - /** * @var float The remittance amount */ public $remittanceAmount; - /** * @var float The collect amount */ public $collectAmount; - /** * @var float The sales accrual amount */ public $salesAccrualAmount; - /** * @var float The taxable sales accrual amount */ public $taxableAccrualAmount; - /** * @var float The nontaxable accrual amount */ public $nonTaxableAccrualAmount; - /** * @var float The tax accrual amount */ public $taxAccrualAmount; - /** * @var float reportableSalesAmount */ public $reportableSalesAmount; - /** * @var float reportableNonTaxableAmount */ public $reportableNonTaxableAmount; - /** * @var float reportableTaxableAmount */ public $reportableTaxableAmount; - /** * @var float reportableTaxAmount */ public $reportableTaxAmount; - } - /** * Represents a listing of all tax calculation data for filings and for accruing to future filings. */ class FilingsTaxDetailsModel { - /** * @var string The tax type associated with the summary */ public $taxType; - /** * @var float The total sales amount */ public $salesAmount; - /** * @var float The nontaxable amount */ public $nonTaxableAmount; - /** * @var float The tax amount */ public $taxAmount; - /** * @var int The number of nights */ public $numberOfNights; - } - /** * Regions */ class MultiTaxFilingRegionModel { - /** * @var string The two-character ISO-3166 code for the country. */ public $country; - /** * @var string The two or three character region code for the region. */ public $region; - /** * @var boolean Whether or not you have nexus in this region. */ public $hasNexus; - /** * @var string The current status of the filing region. (See FilingStatusId::* for a list of allowable values) */ public $status; - /** * @var FilingsTaxSummaryModel A summary of all taxes compbined for this period */ public $regionTaxSummary; - /** * @var FilingsTaxDetailsModel[] A detailed breakdown of the taxes in this filing */ public $regionTaxDetails; - /** * @var FilingsCheckupSuggestedFormModel[] A list of tax returns in this region. */ public $suggestReturns; - /** * @var MultiTaxFilingReturnModel[] A list of tax returns in this region. */ public $returns; - } - /** * Filing Returns Model */ class MultiTaxFilingReturnModel { - /** * @var int The unique ID number of this filing return. */ public $id; - /** * @var int The unique ID number of the filing calendar associated with this return. */ public $filingCalendarId; - /** * @var string The current status of the filing return. (See FilingStatusId::* for a list of allowable values) */ public $status; - /** * @var string The filing frequency of the return. (See FilingFrequencyId::* for a list of allowable values) */ public $filingFrequency; - /** * @var string The filing type of the return. (See FilingTypeId::* for a list of allowable values) */ public $filingType; - /** * @var string The name of the form. */ public $formName; - /** * @var string The unique code of the form. */ public $formCode; - /** * @var string A description for the return. */ public $description; - /** * @var int Tax Authority ID of this return */ public $taxAuthorityId; - /** * @var string The date the return was filed by Avalara. */ public $filedDate; - /** * @var string Accrual type of the return (See AccrualType::* for a list of allowable values) */ public $accrualType; - /** * @var string The start date of this return */ public $startPeriod; - /** * @var string The end date of this return */ public $endPeriod; - /** * @var FilingsTaxSummaryModel A summary of all taxes compbined for this period */ public $returnTaxSummary; - /** * @var FilingsTaxDetailsModel[] A detailed breakdown of the taxes in this filing */ public $returnTaxDetails; - /** * @var FilingReturnCreditModel The excluded carry over credit documents */ public $excludedCarryOverCredits; - /** * @var FilingReturnCreditModel The applied carry over credit documents */ public $appliedCarryOverCredits; - /** * @var float Total amount of adjustments on this return */ public $totalAdjustments; - /** * @var FilingAdjustmentModel[] The Adjustments for this return. */ public $adjustments; - /** * @var float Total amount of augmentations on this return */ public $totalAugmentations; - /** * @var FilingAugmentationModel[] The Augmentations for this return. */ public $augmentations; - /** * @var float Total amount of payments on this return */ public $totalPayments; - /** * @var FilingPaymentModel[] The payments for this return. */ public $payments; - /** * @var FilingAttachmentModel[] The attachments for this return. */ public $attachments; - } - /** * Rebuild a set of filings. */ class RebuildFilingsModel { - /** * @var boolean Set this value to true in order to rebuild the filings. */ public $rebuild; - } - /** * Approve a set of filings. */ class ApproveFilingsModel { - /** * @var boolean Set this value to true in order to approve the filings. */ public $approve; - } - /** * Results of the Worksheet Checkup report */ class FilingsCheckupModel { - /** * @var FilingsCheckupAuthorityModel[] A collection of authorities in the report */ public $authorities; - } - /** * Cycle Safe Expiration results. */ class FilingsCheckupAuthorityModel { - /** * @var int Unique ID of the tax authority */ public $taxAuthorityId; - /** * @var string Location Code of the tax authority */ public $locationCode; - /** * @var string Name of the tax authority */ public $taxAuthorityName; - /** * @var int Type Id of the tax authority */ public $taxAuthorityTypeId; - /** * @var int Jurisdiction Id of the tax authority */ public $jurisdictionId; - /** * @var float Amount of tax collected in this tax authority */ public $tax; - /** * @var string Tax Type collected in the tax authority */ public $taxTypeId; - /** * @var FilingsCheckupSuggestedFormModel[] Suggested forms to file due to tax collected */ public $suggestedForms; - } - /** * Account Linkage output model */ class FirmClientLinkageOutputModel { - /** * @var int The unique ID number of firm-client linkage. */ public $id; - /** * @var int Firm Account to be linked with the firm */ public $firmAccountId; - /** * @var string FIrm Account name */ public $firmAccountName; - /** * @var int Client Account to be linked with the firm */ public $clientAccountId; - /** * @var string Client Account name */ public $clientAccountName; - /** * @var string Created date of the linkage */ public $createdDate; - /** * @var int User who created the linkage */ public $createdUserId; - /** * @var string Modified date of the linkage */ public $modifiedDate; - /** * @var int User who modified the linkage */ public $modifiedUserId; - /** * @var string The status of the account linkage. The following are the available statuses * Requested - When a linkage is requested * Approved - When the linkage is approved * Rejected - When the linkage is rejected * Revoked - When the linkage is revoked. (See FirmClientLinkageStatus::* for a list of allowable values) */ public $status; - /** * @var boolean This is set to 1 if the linkage is deleted. */ public $isDeleted; - /** * @var string Name of the firm's point of contact person for the client */ public $firmContactName; - /** * @var string Email of the firm's point of contact person for the client */ public $firmContactEmail; - } - /** * Account Linkage Input model */ class FirmClientLinkageInputModel { - /** * @var int Client AccountId that needs to be linked to the firm */ public $clientAccountId; - /** * @var string Client AccountName that needs to be linked to the firm */ public $clientAccountName; - } - /** * Represents a request for a new account with Avalara for a new Firm client. */ class NewFirmClientAccountRequestModel { - /** * @var string The name of the account to create */ public $accountName; - /** * @var string First name of the primary contact person for this account */ public $firstName; - /** * @var string Last name of the primary contact person for this account */ public $lastName; - /** * @var string Title of the primary contact person for this account */ public $title; - /** * @var string Phone number of the primary contact person for this account */ public $phoneNumber; - /** * @var string Email of the primary contact person for this account */ public $email; - /** * @var string Company code to be assigned to the company created for this account. If no company code is provided, this will be defaulted to "DEFAULT" company code. */ public $companyCode; - /** * @var CompanyAddress Address information of the account being created. */ public $companyAddress; - /** * @var string United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual. This value is required if the address provided is inside the US. Otherwise it is optional. */ public $taxPayerIdNumber; - /** * @var string[] Properties of the primary contact person for this account */ public $properties; - } - /** * Product classification input model. */ class ItemClassificationInputModel { - /** * @var string The product code of an item in a given system. */ public $productCode; - /** * @var string The system code in which the product belongs. */ public $systemCode; - } - /** * Product classification output model. */ class ItemClassificationOutputModel { - /** * @var int The unique ID number of this product. */ public $id; - /** * @var int The unique ID number of the item this product belongs to. */ public $itemId; - /** * @var int The system id which the product belongs. */ public $systemId; - /** * @var string A unique code representing this item. */ public $productCode; - /** * @var string A unique code representing this item. */ public $systemCode; - } - /** * Represents a request to sync items. */ class SyncItemsRequestModel { - /** * @var ItemSyncModel[] A list of items to sync with AvaTax. */ public $items; - } - /** * An abridged item model used for syncing product catalogs with AvaTax. */ class ItemSyncModel { - /** * @var string A unique code representing this item. */ public $itemCode; - /** * @var string A friendly description of the item. If your company has enrolled in Streamlined Sales Tax, this description must be auditable. */ public $description; - /** * @var string A group to which the item belongs. */ public $itemGroup; - /** * @var string The tax code of the item (optional) */ public $taxCode; - } - /** * The response returned after an item sync was requested. */ class SyncItemsResponseModel { - /** * @var string The status of the request */ public $status; - } - /** * Tells you whether this location object has been correctly set up to the local jurisdiction's standards */ class LocationValidationModel { - /** * @var boolean True if the location has a value for each jurisdiction-required setting. The user is required to ensure that the values are correct according to the jurisdiction; this flag does not indicate whether the taxing jurisdiction has accepted the data you have provided. */ public $settingsValidated; - /** * @var LocationQuestionModel[] A list of settings that must be defined for this location */ public $requiredSettings; - } - /** * Expire a location without restriction then update with new remittance and dates. */ class UpdateCompanyLocationRemittanceModel { - /** * @var string Indicates whether this location is a physical place of business or a temporary salesperson location. (See AddressCategoryId::* for a list of allowable values) */ public $addressCategoryId; - /** * @var string The date when this location was opened for business. */ public $effectiveDate; - /** * @var string If this place of business has closed, the date when this location closed business. If null it'll be set to the date of 9998-12-31. */ public $endDate; - } - /** * Commit this MultiDocument object so that all transactions within it can be reported on a tax filing. */ class CommitMultiDocumentModel { - /** * @var string Represents the unique code of this MultiDocument transaction. A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`. /// */ public $code; - /** * @var string Represents the document type of this MultiDocument transaction. For more information about document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/). A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`. (See DocumentType::* for a list of allowable values) */ public $type; - /** * @var boolean Set this value to be `true` to commit this transaction. Committing a transaction allows it to be reported on a tax filing. Uncommitted transactions will not be reported. */ public $commit; - } - /** * A MultiDocument transaction represents a sale or purchase that occurred between more than two companies. * @@ -11813,92 +9395,73 @@ class CommitMultiDocumentModel */ class MultiDocumentModel { - /** * @var int The unique ID number of this MultiDocument object. */ public $id; - /** * @var int The unique ID number of the AvaTax customer account that created this MultiDocument object. */ public $accountId; - /** * @var string The transaction code of the MultiDocument transaction. All individual transactions within this MultiDocument object will have this code as a prefix. */ public $code; - /** * @var string Indicates the type of MultiDocument transaction. Common values are: * SalesOrder - An estimate that is not permanently recorded * SalesInvoice - An invoice that can be reported on a tax return For more information about document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/) (See DocumentType::* for a list of allowable values) */ public $type; - /** * @var int The user ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was created. */ public $createdDate; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var TransactionModel[] A separate document will exist for each unique combination of buyer and seller in this MultiDocument transaction. */ public $documents; - } - /** * Refund a committed transaction */ class RefundTransactionModel { - /** * @var string The transaction code for the refund. This code will be saved to the `ReturnInvoice` transaction, and does not need to match the code of the original sale. */ public $refundTransactionCode; - /** * @var string The date of the refund. For customers using Avalara's Managed Returns Service, this date controls the month in which the refund transaction will be reported on a tax filing. */ public $refundDate; - /** * @var string Type of this refund. To submit a full refund, specify `Full`. To refund only specific lines from the transaction, specify `Partial` and indicate the lines you wish to apply in the `refundLines` field. To refund the tax that was paid in the previous transaction, specify `TaxOnly`. To issue a percentage-based discount, specify `Percentage`. (See RefundType::* for a list of allowable values) */ public $refundType; - /** * @var float The percentage for refund. This value only applies if you choose `refundType = Percentage` or `refundType = Partial`. */ public $refundPercentage; - /** * @var string[] If you chose a refund of type `Partial`, this indicates which lines from the original transaction are being refunded. */ public $refundLines; - /** * @var string A user-defined reference field containing information about this refund. */ public $referenceCode; - } - /** * A MultiDocument transaction represents a sale or purchase that occurred between more than two companies. * @@ -11909,383 +9472,304 @@ class RefundTransactionModel */ class CreateMultiDocumentModel { - /** * @var string The transaction code of the MultiDocument transaction. All individual transactions within this MultiDocument object will have this code as a prefix. If you leave the `code` field blank, a GUID will be assigned. */ public $code; - /** * @var MultiDocumentLineItemModel[] Lines that will appear on the invoice. For a MultiDocument transaction, each line may represent a different company or reporting location code. AvaTax will separate this MultiDocument transaction object into many different transactions, one for each pair of legal entities, so that each legal entity can file their transactional taxes correctly. */ public $lines; - /** * @var boolean Set this value to true to allow this API call to adjust the MultiDocument model if one already exists. If you omit this field, or if the value is `null`, you will receive an error if you try to create two MultiDocument objects with the same `code`. */ public $allowAdjust; - /** * @var string Specifies the type of document to create. A document type ending with `Invoice` is a permanent transaction that will be recorded in AvaTax. A document type ending with `Order` is a temporary estimate that will not be preserved. If you omit this value, the API will assume you want to create a `SalesOrder`. (See DocumentType::* for a list of allowable values) */ public $type; - /** * @var string Company Code - Specify the code of the company creating this transaction here. If you leave this value null, your account's default company will be used instead. */ public $companyCode; - /** * @var string Transaction Date - The date on the invoice, purchase order, etc. By default, this date will be used to calculate the tax rates for the transaction. If you wish to use a different date to calculate tax rates, please specify a `taxOverride` of type `taxDate`. */ public $date; - /** * @var string Salesperson Code - The client application salesperson reference code. */ public $salespersonCode; - /** * @var string Customer Code - The client application customer reference code. Note: This field is case sensitive. To have exemption certificates apply, this value should be the same as the one passed to create a customer. */ public $customerCode; - /** * @var string DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use entityUseCode instead. Customer Usage Type - The client application customer or usage type. */ public $customerUsageType; - /** * @var string Entity Use Code - The client application customer or usage type. For a list of available usage types, use [ListEntityUseCodes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListEntityUseCodes/) API. */ public $entityUseCode; - /** * @var float Discount - The discount amount to apply to the document. This value will be applied only to lines that have the `discounted` flag set to true. If no lines have `discounted` set to true, this discount cannot be applied. */ public $discount; - /** * @var string Purchase Order Number for this document. This is required for single use exemption certificates to match the order and invoice with the certificate. */ public $purchaseOrderNo; - /** * @var string Exemption Number for this document. If you specify an exemption number for this document, this document will be considered exempt, and you may be asked to provide proof of this exemption certificate in the event that you are asked by an auditor to verify your exemptions. Note: This is same as 'exemptNo' in TransactionModel. */ public $exemptionNo; - /** * @var AddressesModel Default addresses for all lines in this document. These addresses are the default values that will be used for any lines that do not have their own address information. If you specify addresses for a line, then no default addresses will be loaded for that line. */ public $addresses; - /** * @var TransactionParameterModel[] Special parameters for this transaction. To get a full list of available parameters, please use the [ListParameters](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListParameters/) endpoint. */ public $parameters; - /** * @var string Customer-provided Reference Code with information about this transaction. This field could be used to reference the original document for a return invoice, or for any other reference purpose. */ public $referenceCode; - /** * @var string Sets the sale location code (Outlet ID) for reporting this document to the tax authority. This value is used by Avalara Managed Returns to group documents together by reporting locations for tax authorities that require location-based reporting. */ public $reportingLocationCode; - /** * @var boolean Causes the document to be committed if true. This option is only applicable for invoice document types, not orders. */ public $commit; - /** * @var string BatchCode for batch operations. */ public $batchCode; - /** * @var TaxOverrideModel Specifies a tax override for the entire document */ public $taxOverride; - /** * @var string The three-character ISO 4217 currency code for this transaction. */ public $currencyCode; - /** * @var string Specifies whether the tax calculation is handled Local, Remote, or Automatic (default). This only applies when using an AvaLocal server. (See ServiceMode::* for a list of allowable values) */ public $serviceMode; - /** * @var float Currency exchange rate from this transaction to the company base currency. This only needs to be set if the transaction currency is different than the company base currency. It defaults to 1.0. */ public $exchangeRate; - /** * @var string Effective date of the exchange rate. */ public $exchangeRateEffectiveDate; - /** * @var string Sets the Point of Sale Lane Code sent by the User for this document. */ public $posLaneCode; - /** * @var string VAT business identification number for the customer for this transaction. This number will be used for all lines in the transaction, except for those lines where you have defined a different business identification number. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules. */ public $businessIdentificationNo; - /** * @var boolean Specifies if the transaction should have value-added and cross-border taxes calculated with the seller as the importer of record. Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer of record will then be the company designated to pay taxes marked as being obligated to the importer of record. Set this value to `true` to consider your company as the importer of record and collect these taxes. This value may also be set at the Nexus level. See `NexusModel` for more information. */ public $isSellerImporterOfRecord; - /** * @var string User-supplied description for this transaction. */ public $description; - /** * @var string User-supplied email address relevant for this transaction. */ public $email; - /** * @var string If the user wishes to request additional debug information from this transaction, specify a level higher than `normal`. (See TaxDebugLevel::* for a list of allowable values) */ public $debugLevel; - } - /** * Represents one line item in a MultiDocument transaction */ class MultiDocumentLineItemModel { - /** * @var string Specify the code of the company for this line of transaction. If you leave this value null, the `companyCode` at the root level will be used instead. */ public $companyCode; - /** * @var string Sets the sale location code (Outlet ID) for reporting this document to the tax authority. If you leave this value `null`, the `reportingLocationCode` at the root level will be used instead. */ public $reportingLocationCode; - /** * @var string The line number of this line within the document. This can be any text that is useful to you, such as numeric line numbers, alphabetic line numbers, or other text. */ public $number; - /** * @var float Quantity of items in this line. This quantity value should always be a positive value representing the quantity of product that changed hands, even when handling returns or refunds. If not provided, or if set to zero, the quantity value is assumed to be one (1). */ public $quantity; - /** * @var float Total amount for this line. The amount represents the net currency value that changed hands from the customer (represented by the `customerCode` field) to the company (represented by the `companyCode`) field. For sale transactions, this value must be positive. It indicates the amount of money paid by the customer to the company. For refund or return transactions, this value must be negative. */ public $amount; - /** * @var AddressesModel The addresses to use for this transaction line. If you set this value to `null`, or if you omit this element from your API call, then instead the transaction will use the `addresses` from the document level. If you specify any other value besides `null`, only addresses specified for this line will be used for this line. */ public $addresses; - /** * @var string Tax Code - System or Custom Tax Code. You can use your own tax code mapping or standard Avalara tax codes. For a full list of tax codes, see `ListTaxCodes`. */ public $taxCode; - /** * @var string DEPRECATED - Date: 10/16/2017, Version: 17.11, Message: Please use `entityUseCode` instead. */ public $customerUsageType; - /** * @var string Entity Use Code - The client application customer or usage type. This field allows you to designate a type of usage that may make this transaction considered exempt by reason of exempt usage. For a list of entity use codes, see the Definitions API `ListEntityUseCodes`. */ public $entityUseCode; - /** * @var string Item Code (SKU). If you provide an `itemCode` field, the AvaTax API will look up the item you created with the `CreateItems` API call and use all the information available about that item for this transaction. */ public $itemCode; - /** * @var string The customer Tax Id Number (tax_number) associated with a certificate - Sales tax calculation requests first determine if there is an applicable ECMS entry available, and will utilize it for exemption processing. If no applicable ECMS entry is available, the AvaTax service will determine if an Exemption Number field is populated or an Entity/Use Code is included in the sales tax calculation request, and will perform exemption processing using either of those two options. Note: This is same as 'exemptNo' in TransactionModel. */ public $exemptionCode; - /** * @var boolean True if the document discount should be applied to this line. If this value is false, or not provided, discounts will not be applied to this line even if they are specified on the root `discount` element. */ public $discounted; - /** * @var boolean Indicates whether the `amount` for this line already includes tax. If this value is `true`, the final price of this line including tax will equal the value in `amount`. If this value is `null` or `false`, the final price will equal `amount` plus whatever taxes apply to this line. */ public $taxIncluded; - /** * @var string Revenue Account (Customer Defined Field). This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation. */ public $revenueAccount; - /** * @var string Ref1 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation. */ public $ref1; - /** * @var string Ref2 (Customer Defined Field) This field is available for you to use to provide whatever information your implementation requires. It does not affect tax calculation. */ public $ref2; - /** * @var string Item description. For Streamlined Sales Tax (SST) customers, this field is required if an unmapped `itemCode` is used. */ public $description; - /** * @var string VAT business identification number for the customer for this line item. If you leave this field empty, this line item will use whatever business identification number you provided at the transaction level. If you specify a VAT business identification number for the customer in this transaction and you have also set up a business identification number for your company during company setup, this transaction will be treated as a business-to-business transaction for VAT purposes and it will be calculated according to VAT tax rules. */ public $businessIdentificationNo; - /** * @var TaxOverrideModel Specifies a tax override for this line. */ public $taxOverride; - /** * @var TransactionLineParameterModel[] Special parameters that apply to this line within this transaction. To get a full list of available parameters, please use the `ListParameters` API. */ public $parameters; - /** * @var string The Item code for Custom Duty / Global Import tax determination Harmonized Tariff System code for this transaction. For a list of harmonized tariff codes, see the Definitions API for harmonized tariff codes. */ public $hsCode; - } - /** * Replace an existing MultiDocument transaction recorded in AvaTax with a new one. */ class AdjustMultiDocumentModel { - /** * @var string A reason code indicating why this adjustment was made (See AdjustmentReason::* for a list of allowable values) */ public $adjustmentReason; - /** * @var string If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other). */ public $adjustDescription; - /** * @var CreateMultiDocumentModel Replace the current MultiDocument transaction with tax data calculated for this new MultiDocument transaction */ public $newTransaction; - } - /** * A request to void a previously created transaction */ class VoidTransactionModel { - /** * @var string Please specify the reason for voiding or cancelling this transaction. To void the transaction, please specify the reason 'DocVoided'. If you do not provide a reason, the void command will fail. (See VoidReasonCode::* for a list of allowable values) */ public $code; - } - /** * Information about a previously created MultiDocument transaction */ class AuditMultiDocumentModel { - /** * @var ReconstructedMultiDocumentModel Reconstructed API request/response pair that can be used to adjust or re-create this MultiDocument transaction. */ public $reconstructed; - /** * @var string Represents the unique code of this MultiDocument transaction. A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`. */ public $code; - /** * @var string Represents the document type of this MultiDocument transaction. For more information about document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/). A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`. (See DocumentType::* for a list of allowable values) */ public $type; - /** * @var string Server timestamp, in UTC, of the date/time when the original transaction was created */ public $serverTimestamp; - /** * @var string Length of time the original API call took */ public $serverDuration; - /** * @var string api call status (See ApiCallStatus::* for a list of allowable values) */ public $apiCallStatus; - /** * @var OriginalApiRequestResponseModel Original API request/response */ public $original; - } - /** * Contains information about the original API request and response that created * a MultiDocument object. */ class ReconstructedMultiDocumentModel { - /** * @var CreateMultiDocumentModel The original request that was used to create a MultiDocument object. */ public $request; - } - /** * Represents the exact API request and response from the original transaction API call, if available */ class OriginalApiRequestResponseModel { - /** * @var CreateTransactionModel API request */ public $request; - /** * @var TransactionModel API response */ public $response; - } - /** * Verify that a MultiDocument object matches the information in your accounting system. * @@ -12296,70 +9780,55 @@ class OriginalApiRequestResponseModel */ class VerifyMultiDocumentModel { - /** * @var string Represents the unique code of this MultiDocument transaction. A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`. */ public $code; - /** * @var string Represents the document type of this MultiDocument transaction. For more information about document types, see [DocumentType](https://developer.avalara.com/api-reference/avatax/rest/v2/models/enums/DocumentType/). A MultiDocument transaction is uniquely identified by its `accountId`, `code`, and `type`. (See DocumentType::* for a list of allowable values) */ public $type; - /** * @var string Set this value if you wish to verify a match between `verifyTransactionDate` and the `documentDate` value on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field. */ public $verifyTransactionDate; - /** * @var float Set this value if you wish to verify a match between `verifyTotalAmount` and the `totalAmount` value on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field. */ public $verifyTotalAmount; - /** * @var float Set this value if you wish to verify a match between `verifyTotalTax` and the `totalTax` value on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field. */ public $verifyTotalTax; - } - /** * Nexus summary model */ class NexusSummaryModel { - /** * @var int Company Id */ public $companyId; - /** * @var NexusTaxTypeGroupCountModel[] Nexus summary for this company */ public $nexusSummary; - } - /** * Nexus tax type groupe with count */ class NexusTaxTypeGroupCountModel { - /** * @var string Which nexus tax type group */ public $nexusTaxTypeGroup; - /** * @var int How many nexus in the group */ public $count; - } - /** * Use this object to provide an address and date range where your company does business. * This address will be used to determine what jurisdictions you should declare nexus and @@ -12367,69 +9836,55 @@ class NexusTaxTypeGroupCountModel */ class DeclareNexusByAddressModel { - /** * @var string The earliest date on which your company does business at this address. If you omit a value in this field, nexus will be declared at the earliest possible date for this jurisdiction. */ public $effectiveDate; - /** * @var string The date on which your company stopped doing business at this address, or empty if your company has no plans to stop doing business at this address. */ public $endDate; - /** * @var string Specify the text case for the validated address result. If not specified, will return uppercase. (See TextCase::* for a list of allowable values) */ public $textCase; - /** * @var string First line of the street address */ public $line1; - /** * @var string Second line of the street address */ public $line2; - /** * @var string Third line of the street address */ public $line3; - /** * @var string City component of the address */ public $city; - /** * @var string 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`. */ public $region; - /** * @var string 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`. */ public $country; - /** * @var string Postal Code / Zip Code component of the address. */ public $postalCode; - /** * @var float Geospatial latitude measurement, in Decimal Degrees floating point format. */ public $latitude; - /** * @var float Geospatial longitude measurement, in Decimal Degrees floating point format. */ public $longitude; - } - /** * Contains information about nexus jurisdictions that were declared * as a result of a call to `DeclareNexusByAddress`. For each address, @@ -12438,19 +9893,15 @@ class DeclareNexusByAddressModel */ class NexusByAddressModel { - /** * @var DeclareNexusByAddressModel The address that was provided by the user in the call to `DeclareNexusByAddress` */ public $address; - /** * @var NexusModel[] List of all nexus objects that were affected by declaring nexus at the address specified by `address`. */ public $declaredNexus; - } - /** * Represents a letter received from a tax authority regarding tax filing. * These letters often have the warning "Notice" printed at the top, which is why @@ -12458,552 +9909,439 @@ class NexusByAddressModel */ class NoticeModel { - /** * @var int The unique ID number of this notice. */ public $id; - /** * @var int The unique ID number of the company to which this notice belongs. */ public $companyId; - /** * @var int The status id of the notice */ public $statusId; - /** * @var string The status of the notice */ public $status; - /** * @var string The received date of the notice */ public $receivedDate; - /** * @var string The closed date of the notice */ public $closedDate; - /** * @var float The total remmitance amount for the notice */ public $totalRemit; - /** * @var string NoticeCustomerTypeID can be retrieved from the definitions API (See NoticeCustomerType::* for a list of allowable values) */ public $customerTypeId; - /** * @var string Name or ISO 3166 code identifying the country that sent this notice. 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`. */ public $country; - /** * @var string Name or ISO 3166 code identifying the region within the country that sent this notice. 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`. */ public $region; - /** * @var int The tax authority id of the notice */ public $taxAuthorityId; - /** * @var string The filing frequency of the notice (See FilingFrequencyId::* for a list of allowable values) */ public $filingFrequency; - /** * @var string The filing type of the notice (See TaxNoticeFilingTypeId::* for a list of allowable values) */ public $filingTypeId; - /** * @var string The ticket reference number of the notice */ public $ticketReferenceNo; - /** * @var string The ticket reference url of the notice */ public $ticketReferenceUrl; - /** * @var string The sales force case of the notice */ public $salesForceCase; - /** * @var string The URL to the sales force case */ public $salesForceCaseUrl; - /** * @var string The tax period of the notice */ public $taxPeriod; - /** * @var int The notice reason id */ public $reasonId; - /** * @var string The notice reason */ public $reason; - /** * @var int The tax notice type id */ public $typeId; - /** * @var string The tax notice type description */ public $type; - /** * @var string The notice customer funding options (See FundingOption::* for a list of allowable values) */ public $customerFundingOptionId; - /** * @var string The priority of the notice (See NoticePriorityId::* for a list of allowable values) */ public $priorityId; - /** * @var string Comments from the customer on this notice */ public $customerComment; - /** * @var boolean Indicator to hide from customer */ public $hideFromCustomer; - /** * @var string Expected resolution date of the notice */ public $expectedResolutionDate; - /** * @var boolean Indicator to show customer this resolution date */ public $showResolutionDateToCustomer; - /** * @var int The unique ID number of the user that closed the notice */ public $closedByUserId; - /** * @var string The user who created the notice */ public $createdByUserName; - /** * @var int The unique ID number of the user that owns the notice */ public $ownedByUserId; - /** * @var string The description of the notice */ public $description; - /** * @var int The ava file form id of the notice */ public $avaFileFormId; - /** * @var int The id of the revenue contact */ public $revenueContactId; - /** * @var int The id of the compliance contact */ public $complianceContactId; - /** * @var string The tax form code of the notice */ public $taxFormCode; - /** * @var string The document reference of the notice */ public $documentReference; - /** * @var string The jurisdiction name of the notice */ public $jurisdictionName; - /** * @var string The jurisdiction type of the notice */ public $jurisdictionType; - /** * @var NoticeCommentModel[] Additional comments on the notice */ public $comments; - /** * @var NoticeFinanceModel[] Finance details of the notice */ public $finances; - /** * @var NoticeResponsibilityDetailModel[] Notice Responsibility Details */ public $responsibility; - /** * @var NoticeRootCauseDetailModel[] Notice Root Cause Details */ public $rootCause; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - } - /** * Represents communication between Avalara and the company regarding the processing of a tax notice. */ class NoticeCommentModel { - /** * @var int The unique ID number of this notice. */ public $id; - /** * @var int The ID of the notice this comment is attached too */ public $noticeId; - /** * @var string The date this comment was entered */ public $date; - /** * @var string TaxNoticeComment */ public $comment; - /** * @var int TaxNoticeCommentUserId */ public $commentUserId; - /** * @var string TaxNoticeCommentUserName */ public $commentUserName; - /** * @var int taxNoticeCommentTypeId */ public $commentTypeId; - /** * @var string taxNoticeCommentType (See CommentType::* for a list of allowable values) */ public $commentType; - /** * @var string TaxNoticeCommentLink */ public $commentLink; - /** * @var string TaxNoticeFileName */ public $taxNoticeFileName; - /** * @var int resourceFileId */ public $resourceFileId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var ResourceFileUploadRequestModel An attachment to the detail */ public $attachmentUploadRequest; - } - /** * Represents estimated financial results from responding to a tax notice. */ class NoticeFinanceModel { - /** * @var int The Unique Id of the Finance Model */ public $id; - /** * @var int The unique ID of the the tax notice associated with the the finance detail */ public $noticeId; - /** * @var string The date of the notice */ public $noticeDate; - /** * @var string The due date of the notice */ public $dueDate; - /** * @var string The sequential number of the notice */ public $noticeNumber; - /** * @var float The amount of tax due on the notice */ public $taxDue; - /** * @var float The amound of penalty listed on the notice */ public $penalty; - /** * @var float The amount of interest listed on the notice */ public $interest; - /** * @var float The amount of credits listed on the notice */ public $credits; - /** * @var float The amount of tax abated on the notice */ public $taxAbated; - /** * @var float The amount of customer penalty on the notice */ public $customerPenalty; - /** * @var float The amount of customer interest on the notice */ public $customerInterest; - /** * @var float The amount of CSP Fee Refund on the notice */ public $cspFeeRefund; - /** * @var string The name of the file attached to the finance detail */ public $fileName; - /** * @var int The ResourceFileId of the finance detail attachment */ public $resourceFileId; - /** * @var string The date when this record was created. */ public $createdDate; - /** * @var int The User ID of the user who created this record. */ public $createdUserId; - /** * @var string The date/time when this record was last modified. */ public $modifiedDate; - /** * @var int The user ID of the user who last modified this record. */ public $modifiedUserId; - /** * @var ResourceFileUploadRequestModel An attachment to the finance detail */ public $attachmentUploadRequest; - } - /** * NoticeResponsibility Model */ class NoticeResponsibilityDetailModel { - /** * @var int The unique ID number of this filing frequency. */ public $id; - /** * @var int TaxNoticeId */ public $noticeId; - /** * @var int TaxNoticeResponsibilityId */ public $taxNoticeResponsibilityId; - /** * @var string The description name of this filing frequency */ public $description; - } - /** * NoticeRootCause Model */ class NoticeRootCauseDetailModel { - /** * @var int The unique ID number of this filing frequency. */ public $id; - /** * @var int TaxNoticeId */ public $noticeId; - /** * @var int TaxNoticeRootCauseId */ public $taxNoticeRootCauseId; - /** * @var string The description name of this root cause */ public $description; - } - /** * A request to upload a file to Resource Files */ class ResourceFileUploadRequestModel { - /** * @var string This stream contains the bytes of the file being uploaded. (This value is encoded as a Base64 string) */ public $content; - /** * @var string The username adding the file */ public $username; - /** * @var int The account ID to which this file will be attached. */ public $accountId; - /** * @var int The company ID to which this file will be attached. */ public $companyId; - /** * @var string The original name of this file. */ public $name; - /** * @var int The resource type ID of this file. */ public $resourceFileTypeId; - /** * @var int Length of the file in bytes. */ public $length; - } - /** * Encapsulates the result of uploading a file to the resource system */ class ResourceFileUploadResultModel { - /** * @var string If the request failed, this contains a description of the error. */ public $message; - /** * @var int If the request succeeded, this is the ID number of the file. */ public $resourceFileId; - /** * @var boolean True if the upload request succeeded. */ public $aaa_success; - } - /** * Represents a single notification. * @@ -13016,410 +10354,325 @@ class ResourceFileUploadResultModel */ class NotificationModel { - /** * @var int The unique id of the notification. */ public $id; - /** * @var int The unique ID number of the account that received this notification. */ public $accountId; - /** * @var int If this notification was tied to a specific company, this will be the unique ID number of the company that received the notification. Notifications that are tied to accounts will have a `NULL` value for `companyId`. */ public $companyId; - /** * @var string The type name of object referred to by this notification, if any. Some notifications may include information about a related data object. For example, if this notification was related to a nexus declaration, the `referenceObject` field would be `Nexus` and the `referenceId` field would be the unique ID number of that nexus. */ public $referenceObject; - /** * @var int The unique reference Id number of the object referred to by this notification, if any. Some notifications may include information about a related data object. For example, if this notification was related to a nexus declaration, the `referenceObject` field would be `Nexus` and the `referenceId` field would be the unique ID number of that nexus. */ public $referenceId; - /** * @var string The severity level of the notification. (See NotificationSeverityLevel::* for a list of allowable values) */ public $severityLevelId; - /** * @var string The category of this notification. Notification categories are a useful way to group related notifications together. Category names may change over time. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration". */ public $category; - /** * @var string The topic of this notification. Notification topics contain information about the notification. They are a summary of the issue and can help you decide what type of action to take. For Example: "Backdated Transactions" or "Nexus Jurisdiction Alerts", or "Certificate Expiration". */ public $topic; - /** * @var string The message for this notification. This is a friendly description of the notification and any relevant information that can help you decide what kind of action, if any, to take in response. */ public $message; - /** * @var boolean If this notification object requires user action to resolve, this value will be set to true. */ public $needsAction; - /** * @var string If there is a specific action suggested by this notification, this is the name of the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`. */ public $actionName; - /** * @var string If there is a specific action suggested by this notification, this is the URL of the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`. */ public $actionLink; - /** * @var string If there is a specific action suggested by this notification, and if this action is requested by a specific due date, this value will be the due date for the action. An action is a suggested next step such as "Review Your Tax Profile." If an action is suggested, you should give the viewer a hyperlink to the location referred to by `actionLink` and give the hyperlink the name `actionName`. For actions that have deadlines, such as "Confirm your tax registration before filing", this value will be set to the deadline date for the action. Otherwise, this value will be null. */ public $actionDueDate; - /** * @var boolean When a user has finished reviewing a notification, they may opt to dismiss it by calling the `DismissNotification` API. This API marks the notification as dismissed, and dismissed notifications will generally not appear in most user interfaces. */ public $dismissed; - /** * @var int If this notification has been dismissed, this indicates the unique ID number of the user that dismissed the notification. */ public $dismissedByUserId; - /** * @var string If this notification has been dismissed, this indicates the timestamp (in UTC time) when the user dismissed the notification. */ public $dismissedDate; - /** * @var string If this notification is time sensitive, this is the latest date when the notification should be displayed to the user. */ public $expireDate; - /** * @var int The unique ID number of the user who created the notification. */ public $createdUserId; - /** * @var string The UTC timestamp of the time when this notification was created. */ public $createdDate; - /** * @var int The unique ID number of the user who most recently modified this notification. */ public $modifiedUserId; - /** * @var string The UTC timestamp of the time when this notification was last modified. */ public $modifiedDate; - } - /** * Password Change Model */ class PasswordChangeModel { - /** * @var string Old Password */ public $oldPassword; - /** * @var string New Password */ public $newPassword; - } - /** * Set Password Model */ class SetPasswordModel { - /** * @var string New Password */ public $newPassword; - } - /** * An input model for executing a report detailed to the document line level */ class ExportDocumentLineModel { - /** * @var string The file format. (See ReportFormat::* for a list of allowable values) */ public $format; - /** * @var string The start date filter for report execution. If no date provided, same date of last month will be used as the startDate. */ public $startDate; - /** * @var string The end date filter for report execution. If no date provided, today's date will be used as the endDate. */ public $endDate; - /** * @var string The transactions in the country you wish to run a report: use "ALL" for all countries use "ALL Non-US" for all international countries or use a single 2-char ISO country code */ public $country; - /** * @var string The state associated with the transactions you wish to run a report on: use "ALL" for all states. */ public $state; - /** * @var string The type of date to filter your transactions (See ReportDateFilter::* for a list of allowable values) */ public $dateFilter; - /** * @var string The transaction type you want to run a report on (See ReportDocType::* for a list of allowable values) */ public $docType; - /** * @var string Format of dates in your rendered report. Example: "MM/dd/yyyy" */ public $dateFormat; - /** * @var string In which culture your report is produced with. Example: "en-US" */ public $culture; - /** * @var string The currency your report is displayed in. Example: "USD" */ public $currencyCode; - } - /** * A model for displaying report task metadata */ class ReportModel { - /** * @var int The unique identifier of the report task */ public $id; - /** * @var int The ID of the account the reported transactions are from */ public $accountId; - /** * @var int The ID of the company the reported transactions are from */ public $companyId; - /** * @var string The type of the report: ExportDocumentLine, etc. */ public $reportType; - /** * @var ReportParametersModel The parametes used to build the report */ public $parameters; - /** * @var string The current status of the report building task */ public $status; - /** * @var int The size of the report file, if available */ public $size; - /** * @var string The format of the report file */ public $format; - /** * @var string The name of the report file, if available */ public $file; - /** * @var string The time when the report task was initiated */ public $createdDate; - /** * @var int The Id of the user who initiated this task */ public $createdUserId; - /** * @var string The userName of the user who initiated the report task */ public $createdUser; - /** * @var string The time when the report was finished building, if completed */ public $completedDate; - } - /** * The output model for report parameter definitions */ class ReportParametersModel { - /** * @var string The start date filter used for your report */ public $startDate; - /** * @var string The end date filter used for your report */ public $endDate; - /** * @var string The country filter used for your report */ public $country; - /** * @var string The state filter used for your report */ public $state; - /** * @var string The date type filter used for your report */ public $dateFilter; - /** * @var string The doc type filter used for your report */ public $docType; - /** * @var string The date format used for your report */ public $dateFormat; - /** * @var string The culture used your report */ public $culture; - /** * @var string The currency code used for your report */ public $currencyCode; - } - /** * Point-of-Sale Data Request Model */ class PointOfSaleDataRequestModel { - /** * @var string A unique code that references a company within your account. */ public $companyCode; - /** * @var string The date associated with the response content. Default is current date. This field can be used to backdate or postdate the response content. */ public $documentDate; - /** * @var string The format of your response. Formats include JSON, CSV, and XML. (See PointOfSaleFileType::* for a list of allowable values) */ public $responseType; - /** * @var string[] A list of tax codes to include in this point-of-sale file. If no tax codes are specified, response will include all distinct tax codes associated with the Items within your company. */ public $taxCodes; - /** * @var string[] A list of item codes to include in this point-of-sale file. If no item codes are specified, responese will include all distinct item codes associated with the Items within your company. */ public $itemCodes; - /** * @var string[] A list of location codes to include in this point-of-sale file. If no location codes are specified, response will include all locations within your company. */ public $locationCodes; - /** * @var boolean Set this value to true to include Juris Code in the response. */ public $includeJurisCodes; - /** * @var string A unique code assoicated with the Partner you may be working with. If you are not working with a Partner or your Partner has not provided you an ID, leave null. (See PointOfSalePartnerId::* for a list of allowable values) */ public $partnerId; - } - /** * SendSales Request Model. */ class SendSalesRequestModel { - /** * @var int The companyId for which the send sales file is being generated. */ public $companyId; - /** * @var string[] List of taxCodes to be included in send sales file. */ public $taxCodes; - /** * @var string The date for which send sales file is being generated. */ public $date; - /** * @var string The send sales file format. (See SendSalesOutputFileFormat::* for a list of allowable values) */ public $format; - /** * @var string The send sales file type (See SendSalesFileType::* for a list of allowable values) */ public $type; - } - /** * Contains information about the general tangible personal property sales tax rates for this jurisdiction. * @@ -13436,65 +10689,51 @@ class SendSalesRequestModel */ class TaxRateModel { - /** * @var float The total sales tax rate for general tangible personal property sold at a retail point of presence in this jurisdiction on this date. */ public $totalRate; - /** * @var RateModel[] The list of individual rate elements for general tangible personal property sold at a retail point of presence in this jurisdiction on this date. */ public $rates; - } - /** * Indicates one element of a sales tax rate. */ class RateModel { - /** * @var float The sales tax rate for general tangible personal property in this jurisdiction. */ public $rate; - /** * @var string A readable name of the tax or taxing jurisdiction related to this tax rate. */ public $name; - /** * @var string The type of jurisdiction associated with this tax rate. (See JurisdictionType::* for a list of allowable values) */ public $type; - } - /** * Replace an existing transaction recorded in AvaTax with a new one. */ class AdjustTransactionModel { - /** * @var string A reason code indicating why this adjustment was made (See AdjustmentReason::* for a list of allowable values) */ public $adjustmentReason; - /** * @var string If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other). */ public $adjustmentDescription; - /** * @var CreateTransactionModel Replace the current transaction with tax data calculated for this new transaction */ public $newTransaction; - } - /** * Settle this transaction with your ledger by executing one or many actions against that transaction. * @@ -13503,24 +10742,19 @@ class AdjustTransactionModel */ class SettleTransactionModel { - /** * @var VerifyTransactionModel To verify this transaction, you may provide information in this field. If you leave this field null, the transaction will not be verified. */ public $verify; - /** * @var ChangeTransactionCodeModel To change the code for this transaction, you may provide information in this field. If you leave this field null, the transaction's code will not be changed. */ public $changeCode; - /** * @var CommitTransactionModel To commit this transaction so that it can be reported on a tax filing, you may provide information in this field. If you leave this field null, the transaction's commit status will not be changed. If you use Avalara's Managed Returns Service, committing a transaction will allow that transaction to be filed. */ public $commit; - } - /** * Verify this transaction by matching it to values in your accounting system. * @@ -13530,24 +10764,19 @@ class SettleTransactionModel */ class VerifyTransactionModel { - /** * @var string Set this value if you wish to verify a match between `verifyTransactionDate` and the `documentDate` value on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field. */ public $verifyTransactionDate; - /** * @var float Set this value if you wish to verify a match between `verifyTotalAmount` and the `totalAmount` value on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field. */ public $verifyTotalAmount; - /** * @var float Set this value if you wish to verify a match between `verifyTotalTax` and the `totalTax` value on the transaction recorded in AvaTax. If you leave this field empty, we will skip verification for this field. */ public $verifyTotalTax; - } - /** * Settle this transaction with your ledger by verifying its amounts. * If the transaction is not yet committed, you may specify the "commit" value to commit it to the ledger and allow it to be reported. @@ -13555,132 +10784,103 @@ class VerifyTransactionModel */ class ChangeTransactionCodeModel { - /** * @var string To change the transaction code for this transaction, specify the new transaction code here. */ public $newCode; - } - /** * Commit this transaction as permanent so that it can be reported on a tax filing. */ class CommitTransactionModel { - /** * @var boolean Set this value to be `true` to commit this transaction. Committing a transaction allows it to be reported on a tax filing. Uncommitted transactions will not be reported. */ public $commit; - } - /** * Commit this transaction as permanent */ class LockTransactionModel { - /** * @var boolean Set this value to be true to commit this transaction. Committing a transaction allows it to be reported on a tax return. Uncommitted transactions will not be reported. */ public $isLocked; - } - /** * Bulk lock documents model */ class BulkLockTransactionModel { - /** * @var int[] List of documents to lock */ public $documentIds; - /** * @var boolean The lock status to set for the documents designated in this API */ public $isLocked; - } - /** * Returns information about transactions that were locked */ class BulkLockTransactionResult { - /** * @var int Number of records that have been modified */ public $numberOfRecords; - } - /** * Create or adjust transaction model */ class CreateOrAdjustTransactionModel { - /** * @var string A reason code indicating why this adjustment was made (See AdjustmentReason::* for a list of allowable values) */ public $adjustmentReason; - /** * @var string If the AdjustmentReason is "Other", specify the reason here. This is required when the AdjustmentReason is 8 (Other). */ public $adjustmentDescription; - /** * @var CreateTransactionModel The create transaction model to be created or updated. If the transaction does not exist, create transaction. If the transaction exists, adjust the existing transaction. */ public $createTransactionModel; - } - /** * Information about a previously created transaction */ class AuditTransactionModel { - /** * @var int Unique ID number of the company that created this transaction */ public $companyId; - /** * @var ReconstructedApiRequestResponseModel Reconstructed API request/response */ public $reconstructed; - /** * @var string Server timestamp, in UTC, of the date/time when the original transaction was created */ public $serverTimestamp; - /** * @var string Length of time the original API call took */ public $serverDuration; - /** * @var string api call status (See ApiCallStatus::* for a list of allowable values) */ public $apiCallStatus; - /** * @var OriginalApiRequestResponseModel Original API request/response */ public $original; - } - /** * This model contains a reconstructed CreateTransaction request object that could potentially be used * to recreate this transaction. @@ -13690,179 +10890,140 @@ class AuditTransactionModel */ class ReconstructedApiRequestResponseModel { - /** * @var CreateTransactionModel API request */ public $request; - } - /** * Model to add specific lines to exising transaction */ class AddTransactionLineModel { - /** * @var string company code */ public $companyCode; - /** * @var string document code for the transaction to add lines */ public $transactionCode; - /** * @var string document type (See DocumentType::* for a list of allowable values) */ public $documentType; - /** * @var LineItemModel[] List of lines to be added */ public $lines; - /** * @var boolean Option to renumber lines after add. After renumber, the line number becomes: "1", "2", "3", ... */ public $renumber; - } - /** * Model to specify lines to be removed */ class RemoveTransactionLineModel { - /** * @var string company code */ public $companyCode; - /** * @var string document code for the transaction to add lines */ public $transactionCode; - /** * @var string document type (See DocumentType::* for a list of allowable values) */ public $documentType; - /** * @var string[] List of lines to be added */ public $lines; - /** * @var boolean ption to renumber lines after removal. After renumber, the line number becomes: "1", "2", "3", ... */ public $renumber; - } - /** * Response model used as output for InspectLine API. */ class InspectLineResponseModel { - /** * @var DeterminationFactorModel[] A list of determination factors for a line that is being inspected through the InspectLine API. */ public $determinationFactors; - } - /** * This object represents a single determination factor for a line that is being inspected through the InspectLine API. */ class DeterminationFactorModel { - /** * @var string Determination reason code. */ public $code; - /** * @var string Determination reason description. */ public $description; - } - /** * User Entitlement Model */ class UserEntitlementModel { - /** * @var string[] List of API names and categories that this user is permitted to access */ public $permissions; - /** * @var string What access privileges does the current user have to see companies? (See CompanyAccessLevel::* for a list of allowable values) */ public $accessLevel; - /** * @var int[] The identities of all companies this user is permitted to access */ public $companies; - } - /** * Ping Result Model */ class PingResultModel { - /** * @var string Version number */ public $version; - /** * @var boolean Returns true if you provided authentication for this API call; false if you did not. */ public $authenticated; - /** * @var string Returns the type of authentication you provided, if authenticated (See AuthenticationTypeId::* for a list of allowable values) */ public $authenticationType; - /** * @var string The username of the currently authenticated user, if any. */ public $authenticatedUserName; - /** * @var int The ID number of the currently authenticated user, if any. */ public $authenticatedUserId; - /** * @var int The ID number of the currently authenticated user's account, if any. */ public $authenticatedAccountId; - /** * @var int The ID number of the currently authenticated user's company, if any. */ public $authenticatedCompanyId; - /** * @var string The connected Salesforce account. */ public $crmid; - -} -?> \ No newline at end of file +}?> \ No newline at end of file From a9193518224f982f1f47bc4abbcfe65f6bc4d3c2 Mon Sep 17 00:00:00 2001 From: "genevieve.conty" Date: Tue, 21 Jul 2020 13:16:35 -0700 Subject: [PATCH 3/3] 20-7-update fixed syntax for CappedFetchResult --- src/Models.php | 29 ++--------------------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/src/Models.php b/src/Models.php index fdfdb30..b3400a7 100644 --- a/src/Models.php +++ b/src/Models.php @@ -7043,7 +7043,7 @@ class CompanyDistanceThresholdModel /** * */ -class CappedFetchResult +class CappedFetchResult { /** * @var boolean @@ -7176,32 +7176,7 @@ class DeleteErrorTransactionResponseModel */ public $documentCode; } -/** - * - */ -class CappedFetchResult -{ - /** - * @var boolean - */ - public $_isRecordsetCountCapped; - /** - * @var int - */ - public $_recordsetCount; - /** - * @var object[] - */ - public $value; - /** - * @var string - */ - public $_nextLink; - /** - * @var string - */ - public $pageKey; -} + /** * Model that has the matching count for an errorcode */