{ "opencollection": "1.0.0", "info": { "name": "Avalara Nexus API", "version": "1.0" }, "items": [ { "info": { "name": "Nexus", "type": "folder" }, "items": [ { "info": { "name": "Avalara List Nexus for a Company", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The numeric ID of the company" }, { "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 all nexus declarations for the specified company." }, { "info": { "name": "Avalara Create Nexus for a Company", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The numeric ID of the company" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Create Nexus for a Company" }, { "info": { "name": "Avalara ListNexusParameters", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:nexusId/parameters", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "nexusId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List parameters for a nexus.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\n \nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name. \n " }, { "info": { "name": "Avalara CreateNexusParameters", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:nexusId/parameters", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "nexusId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Add parameters to the nexus.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\n \nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.\n " }, { "info": { "name": "Avalara DeleteNexusParameters", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:nexusId/parameters", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "nexusId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete all the parameters for a given nexus.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\n \nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter" }, { "info": { "name": "Avalara DeclareNexusByAddress", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/byaddress", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this\nAPI declares nexus for this company, for the list of addresses provided,\nfor the date range provided. You may also use this API to extend effective date on an already-declared nexus.\n \nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per ju" }, { "info": { "name": "Avalara GetNexus", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get the nexus object identified by this URL.\n \nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.\nYou may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:\n \n" }, { "info": { "name": "Avalara UpdateNexus", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:id", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Replace the existing nexus declaration object at this URL with an updated object.\n \nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.\n \nTo create a nexus declaration for your company, you must first call the Definitions API `ListNexus` to obtain a\nlist o" }, { "info": { "name": "Avalara DeleteNexus", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Marks the existing nexus object at this URL as deleted.\n \nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.\n \nPlease note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\nof calculating tax f" }, { "info": { "name": "Avalara GetNexusParameter", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "nexusId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a single nexus parameter.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\n \nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.\n\n###" }, { "info": { "name": "Avalara UpdateNexusParameter", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "nexusId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update an nexus parameter.\n \nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added.\n \nA parameter specified on a transaction line will override an item parameter if they share the " }, { "info": { "name": "Avalara DeleteNexusParameter", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "nexusId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a single nexus parameter.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\n \nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.\n\n### " }, { "info": { "name": "Avalara GetNexusByFormCode", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/byform/:formCode", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "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 is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.\n \nThis API is intended to provide useful information when examining a tax form. If you are about to begin filing\na tax form, you may want to know whethe" }, { "info": { "name": "Avalara ListNexusByCompanyAndTaxTypeGroup", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/nexus/byTaxTypeGroup/:taxTypeGroup", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "taxTypeGroup", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all nexus objects defined for this company filtered by TaxTypeGroup.\n \nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.\n \nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in RE" }, { "info": { "name": "Avalara QueryNexus", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/nexus", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get multiple nexus objects across all companies.\n \nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.\n \nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.aval" } ] } ], "bundled": true }