{ "opencollection": "1.0.0", "info": { "name": "Avalara Locations API", "version": "1.0" }, "items": [ { "info": { "name": "Locations", "type": "folder" }, "items": [ { "info": { "name": "Avalara List Locations for a Company", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations", "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": "Avalara List Locations for a Company" }, { "info": { "name": "Avalara Create Locations for a Company", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations", "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 Locations for a Company" }, { "info": { "name": "Avalara List Locations", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/Locations", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Avalara List Locations" }, { "info": { "name": "Avalara Create a Location", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/Locations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Avalara Create a Location" }, { "info": { "name": "Avalara ListLocationParameters", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/:locationId/parameters", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "locationId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List parameters for a location.\n \nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.\n \nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n \nSe" }, { "info": { "name": "Avalara CreateLocationParameters", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/:locationId/parameters", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "locationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Add parameters to a location.\n \nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.\n \nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n \nTo s" }, { "info": { "name": "Avalara GetLocation", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/: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 location object identified by this URL.\nAn 'Location' represents a physical address where a company does business.\nMany taxing authorities require that you define a list of all locations where your company does business.\nThese locations may require additional custom configuration or tax registration with these authorities.\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.\n \nYou may specify one or more of the following values in" }, { "info": { "name": "Avalara UpdateLocation", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/: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 location object at this URL with an updated object.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara DeleteLocation", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/: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": "Mark the location object at this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara GetLocationParameter", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "locationId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a single location parameter.\n \nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.\n \nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n\n### Secu" }, { "info": { "name": "Avalara UpdateLocationParameter", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "locationId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update a location parameter.\n \nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.\n \nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n\n### Security Poli" }, { "info": { "name": "Avalara DeleteLocationParameter", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "locationId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a single location parameter.\n \nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\n \nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.\n \nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n\n### Securi" }, { "info": { "name": "Avalara QueryLocations", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/locations", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get multiple location objects across all companies.\nAn 'Location' represents a physical address where a company does business.\nMany taxing authorities require that you define a list of all locations where your company does business.\nThese locations may require additional custom configuration or tax registration with these authorities.\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.\n \nSearch for specific objects using the criteria in " }, { "info": { "name": "Avalara ValidateLocation", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/locations/:id/validate", "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": "Returns validation information for this location.\nThis API call is intended to compare this location against the currently known taxing authority rules and regulations,\nand provide information about what additional work is required to completely setup this location.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, SiteAdmin" } ] } ], "bundled": true }