{ "opencollection": "1.0.0", "info": { "name": "Avalara Definitions API", "version": "1.0" }, "items": [ { "info": { "name": "Definitions", "type": "folder" }, "items": [ { "info": { "name": "Avalara List All Tax Codes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxcodes", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression for result filtering" }, { "name": "$top", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the full list of Avalara-supported tax codes for product and service classification." }, { "info": { "name": "Avalara List Nexus Options for a Country", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/nexus/:country", "params": [ { "name": "country", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara List Nexus Options for a Country" }, { "info": { "name": "Avalara List All Jurisdictions", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/jurisdictions", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression for result filtering" }, { "name": "$top", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara List All Jurisdictions" }, { "info": { "name": "Avalara List All Countries Supported by AvaTax", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/countries", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression for result filtering" }, { "name": "$top", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara List All Countries Supported by AvaTax" }, { "info": { "name": "Avalara List All Entity Use Codes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/entityusecodes", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression for result filtering" }, { "name": "$top", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of entity use codes that can be applied to transactions to indicate exemptions or special tax handling." }, { "info": { "name": "Avalara GetCrossBorderCode", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/crossborder/:country/:hsCode/hierarchy", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "hsCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings\n \na list of HS Codes that are the parents and information branches of the HS Code for the given\ndestination country, if lower detail is available.\n \nThis API will include information branches if applicable. These do not have HS Codes and cannot be referenced,\nbut can contain information relevant to deciding the correct HS Code.\n \nThis API is intend" }, { "info": { "name": "Avalara GetLoginVerifierByForm", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/filingcalendars/loginverifiers/:form", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "form", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This API is intended to be useful to identify whether the user should be allowed\nto automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification." }, { "info": { "name": "Avalara ListAllMarketplaceLocations", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/listallmarketplacelocations", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all market place locations." }, { "info": { "name": "Avalara ListAvaFileForms", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/avafileforms", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This API is deprecated.\n \nPlease use the ListTaxForms API.\n \nReturns the full list of Avalara-supported AvaFile Forms\nThis API is intended to be useful to identify all the different AvaFile Forms" }, { "info": { "name": "Avalara ListCertificateAttributes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/certificateattributes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List the certificate attributes defined by a company either specified by the user or the user's default company.\n \nA certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a\ncertificate at any time.\n \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account." }, { "info": { "name": "Avalara ListCertificateExemptReasons", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/certificateexemptreasons", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List the certificate exempt reasons defined by a company.\n \nAn exemption reason defines why a certificate allows a customer to be exempt\nfor purposes of tax calculation.\n \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account." }, { "info": { "name": "Avalara ListCertificateExposureZones", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/certificateexposurezones", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List the certificate exposure zones defined by a company.\n \nAn exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing\nauthority or other legal entity to which a certificate may apply.\n \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account." }, { "info": { "name": "Avalara ListClassificationParametersUsage", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/classification/parametersusage", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported usage of extra parameters for item classification.\nThe list of parameters is available for use with Item Classification.\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, { "info": { "name": "Avalara ListCommunicationsServiceTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/communications/transactiontypes/:id/servicetypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns full list of service types for a given transaction type ID." }, { "info": { "name": "Avalara ListCommunicationsTSPairs", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/communications/tspairs", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns full list of communications transaction/service type pairs which\nare accepted in communication tax calculation requests." }, { "info": { "name": "Avalara ListCommunicationsTransactionTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/communications/transactiontypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns full list of communications transaction types which\nare accepted in communication tax calculation requests." }, { "info": { "name": "Avalara ListCoverLetters", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/coverletters", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.\n \nThe CoverLetter model represents a message sent along with an invitation to use CertExpress to\nupload certificates. An invitation allows customers to use CertExpress to upload their exemption\ncertificates directly; this cover letter explains why the invitation was sent.\n \nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProv" }, { "info": { "name": "Avalara ListCrossBorderCodes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/crossborder/:country/:hsCode", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "hsCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if\nadditional children are available.\n \nHS Code is interchangeable with \"tariff code\" and definitions are generally unique to a destination country.\nAn HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by\nSection/Chapter/Heading/Subheading/Classification.\n \nThis API is intended to be useful to identify the correct HS Code to use for your i" }, { "info": { "name": "Avalara ListCrossBorderSections", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/crossborder/sections", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for\nclassifying tariff codes and the items to which they apply. HS Codes are organized\nby Section/Chapter/Heading/Subheading/Classification.\n \nThis API is intended to be useful to identify the top level Sections for\nfurther LandedCost HS Code lookups.\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): AvaTaxGlobal.\n" }, { "info": { "name": "Avalara ListCurrencies", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/currencies", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Lists all ISO 4217 currencies supported by AvaTax.\n \nThis API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the\n`currencyCode` field in a `CreateTransactionModel`." }, { "info": { "name": "Avalara ListFilingFrequencies", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/filingfrequencies", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported filing frequencies.\nThis API is intended to be useful to identify all the different filing frequencies that can be used in notices." }, { "info": { "name": "Avalara ListJurisdictionTypesByRateTypeTaxTypeMapping", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/jurisdictionTypes/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "taxTypeId", "value": "", "type": "path" }, { "name": "taxSubTypeId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId" }, { "info": { "name": "Avalara ListJurisdictionsByAddress", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/jurisdictionsnearaddress", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.\n \nThis API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.\nIt is intended to allow you to create a \"Jurisdiction Override\", which allows an address to be configured as belonging to a nearby\njurisdiction in AvaTax.\n \nThe results of this API call can be passed to the `CreateJurisdictionOverride` API call." }, { "info": { "name": "Avalara ListJurisdictionsByRateTypeTaxTypeMapping", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/jurisdictions/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "taxTypeId", "value": "", "type": "path" }, { "name": "taxSubTypeId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of all Avalara-supported taxing jurisdictions filtered by taxTypeId, taxSubTypeId, country, and rateTypeId.\n \nYou can optionally pass region as a query parameter to retrieve jurisdictions that are under that region.\n \nThis API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying\nSQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'\n \nThe jurisdictionTyp" }, { "info": { "name": "Avalara ListLocationQuestionsByAddress", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/locationquestions", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.\nSome tax jurisdictions require that you register or provide additional information to configure each physical place where\nyour company does business.\nThis information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.\nYou can call this API call for any address and obtain information about what questions must be ans" }, { "info": { "name": "Avalara ListLoginVerifiers", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/filingcalendars/loginverifiers", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all forms where logins can be verified automatically.\nThis API is intended to be useful to identify whether the user should be allowed\nto automatically verify their login and password." }, { "info": { "name": "Avalara ListMarketplaceLocations", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/marketplacelocations", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the list of suggested locations for a marketplace." }, { "info": { "name": "Avalara ListNexus", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/nexus", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of all Avalara-supported nexus for all countries and regions.\n \nThis API is intended to be useful if your user interface needs to display a selectable list of nexus." }, { "info": { "name": "Avalara ListNexusByAddress", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/nexus/byaddress", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.\nThis API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.\nIn general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address\nwhere the company does business.\nThe results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address." }, { "info": { "name": "Avalara ListNexusByCountryAndRegion", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/nexus/:country/:region", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns all Avalara-supported nexus for the specified country and region.\n \nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region." }, { "info": { "name": "Avalara ListNexusByFormCode", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/nexus/byform/:formCode", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "formCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves a list of nexus related to a tax form.\n \nThe concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated\nto collect and remit transaction-based taxes.\n \nWhen defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax\nin all jurisdictions affected by your transactions.\n \nThis API is intended to provide useful information when examining a tax form. If you are abo" }, { "info": { "name": "Avalara ListNexusByTaxTypeGroup", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/nexus/bytaxtypegroup/:taxTypeGroup", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "taxTypeGroup", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns all Avalara-supported nexus for the specified specified tax type group.\n \nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group." }, { "info": { "name": "Avalara ListNexusTaxTypeGroups", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/nexustaxtypegroups", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported nexus tax type groups\nThis API is intended to be useful to identify all the different tax sub-types." }, { "info": { "name": "Avalara ListNoticeCustomerFundingOptions", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticecustomerfundingoptions", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice customer funding options.\nThis API is intended to be useful to identify all the different notice customer funding options that can be used in notices." }, { "info": { "name": "Avalara ListNoticeCustomerTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticecustomertypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice customer types.\nThis API is intended to be useful to identify all the different notice customer types." }, { "info": { "name": "Avalara ListNoticeFilingtypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticefilingtypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice filing types.\nThis API is intended to be useful to identify all the different notice filing types that can be used in notices." }, { "info": { "name": "Avalara ListNoticePriorities", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticepriorities", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice priorities.\nThis API is intended to be useful to identify all the different notice priorities that can be used in notices." }, { "info": { "name": "Avalara ListNoticeReasons", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticereasons", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice reasons.\nThis API is intended to be useful to identify all the different tax notice reasons." }, { "info": { "name": "Avalara ListNoticeResponsibilities", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticeresponsibilities", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice responsibility ids\nThis API is intended to be useful to identify all the different tax notice responsibilities." }, { "info": { "name": "Avalara ListNoticeRootCauses", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticerootcauses", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice root causes\nThis API is intended to be useful to identify all the different tax notice root causes." }, { "info": { "name": "Avalara ListNoticeStatuses", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticestatuses", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice statuses.\nThis API is intended to be useful to identify all the different tax notice statuses." }, { "info": { "name": "Avalara ListNoticeTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/noticetypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax notice types.\nThis API is intended to be useful to identify all the different notice types that can be used in notices." }, { "info": { "name": "Avalara ListParameters", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/parameters", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.\nThis list of parameters is available for use when configuring your transaction.\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, { "info": { "name": "Avalara ListParametersByAccount", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/accounts/:accountId/parameters", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "accountId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of Avalara-supported parameters based on account subscriptions." }, { "info": { "name": "Avalara ListParametersByItem", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/parameters/byitem/:companyCode/:itemCode", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyCode", "value": "", "type": "path" }, { "name": "itemCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of parameters based on the company's service types and the item code.\nIgnores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.\nIgnores nexus for the AvaAlcohol service type.\n \nNOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:\n* Replace '/' with '\\_-ava2f-\\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'\n* R" }, { "info": { "name": "Avalara ListParametersUsage", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/parametersusage", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call.\nThis list of parameters is available for use when configuring your transaction.\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, { "info": { "name": "Avalara ListPermissions", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/permissions", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported permission types.\nThis API is intended to be useful to identify the capabilities of a particular user logon." }, { "info": { "name": "Avalara ListPostalCodes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/postalcodes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the list of Avalara-supported postal codes." }, { "info": { "name": "Avalara ListPreferredPrograms", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/preferredprograms", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all preferred customs duty programs recognized by AvaTax.\n \nA customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.\nAn example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring\ncountries.\n \nTo select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your\npreferred program. Next, set the para" }, { "info": { "name": "Avalara ListProductClassificationSystems", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/productclassificationsystems", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all available product classification systems.\n \nTax authorities use product classification systems as a way to identify products and associate them with a tax rate.\nMore than one tax authority might use the same product classification system, but they might charge different tax rates for products." }, { "info": { "name": "Avalara ListProductClassificationSystemsByCompany", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/productclassificationsystems/bycompany/:companyCode", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Lists all product classification systems available to a company based on its nexus.\n \nTax authorities use product classification systems as a way to identify products and associate them with a tax rate.\nMore than one tax authority might use the same product classification system, but they might charge different tax rates for products.\n \n \nNOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before makin" }, { "info": { "name": "Avalara ListRateTypesByCountry", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/countries/:country/ratetypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported rate type file types\nThis API is intended to be useful to identify all the different rate types." }, { "info": { "name": "Avalara ListRateTypesByCountryTaxTypeTaxSubType", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId/ratetypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "taxTypeId", "value": "", "type": "path" }, { "name": "taxSubTypeId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the list of Avalara-supported rate type file types\nThis API is intended to be useful to identify all the different rate types." }, { "info": { "name": "Avalara ListRegions", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/regions", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of all ISO 3166 region codes and their US English friendly names.\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region\nwithin the country for a shipping addresses." }, { "info": { "name": "Avalara ListRegionsByCountry", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/countries/:country/regions", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region\nwithin the country for a shipping addresses." }, { "info": { "name": "Avalara ListRegionsByCountryAndTaxTypeAndTaxSubTypeAndRateType", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/companies/:companyId/countries/:country/regions/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId/rateTypeId/:rateTypeId/jurisdictionTypeId/:jurisdictionTypeId", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "country", "value": "", "type": "path" }, { "name": "taxTypeId", "value": "", "type": "path" }, { "name": "taxSubTypeId", "value": "", "type": "path" }, { "name": "rateTypeId", "value": "", "type": "path" }, { "name": "jurisdictionTypeId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of all ISO 3166 region codes for a specific country code and their US English friendly names.\nThis API is intended to be used as a way to provide a dropdown box in your website to allow customers to select a region\nwithin the country for shipping addresses." }, { "info": { "name": "Avalara ListResourceFileTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/resourcefiletypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported resource file types\nThis API is intended to be useful to identify all the different resource file types." }, { "info": { "name": "Avalara ListReturnsParametersUsage", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/returns/parametersusage", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported usage of extra parameters for the returns.\nThis list of parameters is available for use with Returns.\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, { "info": { "name": "Avalara ListSecurityRoles", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/securityroles", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported permission types.\nThis API is intended to be useful when designing a user interface for selecting the security role of a user account.\nSome security roles are restricted for Avalara internal use." }, { "info": { "name": "Avalara ListSubscriptionTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/subscriptiontypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported subscription types.\nThis API is intended to be useful for identifying which features you have added to your account.\nYou may always contact Avalara's sales department for information on available products or services.\nYou cannot change your subscriptions directly through the API." }, { "info": { "name": "Avalara ListTags", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/tags", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the list of suggested locations for a marketplace." }, { "info": { "name": "Avalara ListTaxAuthorities", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxauthorities", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax authorities.\nThis API is intended to be useful to identify all the different authorities that receive tax." }, { "info": { "name": "Avalara ListTaxAuthorityForms", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxauthorityforms", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported forms for each tax authority.\nThis list represents tax forms that Avalara recognizes.\nCustomers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically\nbased on the customer's AvaTax data." }, { "info": { "name": "Avalara ListTaxAuthorityTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxauthoritytypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax authority types.\nThis API is intended to be useful to identify all the different authority types." }, { "info": { "name": "Avalara ListTaxCodeTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxcodetypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of recognized tax code types.\nA 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.\nThis API is intended to be useful for broadly searching for tax codes by tax code type." }, { "info": { "name": "Avalara ListTaxForms", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxforms", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported Tax Forms\nThis API is intended to be useful to identify all the different Tax Forms" }, { "info": { "name": "Avalara ListTaxSubTypes", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxsubtypes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax sub-types\nThis API is intended to be useful to identify all the different tax sub-types." }, { "info": { "name": "Avalara ListTaxSubTypesByCountryAndTaxType", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxsubtypes/countries/:country/taxtypes/:taxTypeId", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "taxTypeId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax sub-types\nThis API is intended to be useful to identify all the different tax sub-types for given country and TaxType." }, { "info": { "name": "Avalara ListTaxSubTypesByJurisdictionAndRegion", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxsubtypes/:jurisdictionCode/:region", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "jurisdictionCode", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax sub-types by jurisdiction and region\nThis API is intended to be useful to identify all the different tax sub-types." }, { "info": { "name": "Avalara ListTaxTypeGroups", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxtypegroups", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the full list of Avalara-supported tax type groups\nThis API is intended to be useful to identify all the different tax type groups." }, { "info": { "name": "Avalara ListTaxTypesByNexusAndCountry", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/taxtypes/countries/:country", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the list of applicable TaxTypes based on Nexus of the company." }, { "info": { "name": "Avalara ListUnitOfBasisByCountryAndTaxTypeAndTaxSubTypeAndRateType", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/unitofbasis/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "country", "value": "", "type": "path" }, { "name": "taxTypeId", "value": "", "type": "path" }, { "name": "taxSubTypeId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves the list of applicable UnitOfBasis" }, { "info": { "name": "Avalara ListUnitOfMeasurement", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/definitions/unitofmeasurements", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all units of measurement systems defined by Avalara.\n \nA unit of measurement system is a method of measuring a quantity, such as distance, mass, or others." } ] } ], "bundled": true }