{ "opencollection": "1.0.0", "info": { "name": "Avalara Accounts API", "version": "1.0" }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Avalara Retrieve a Single Account", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "$include", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Retrieve a Single Account" }, { "info": { "name": "Avalara List All Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/accounts", "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 Accounts" }, { "info": { "name": "Avalara Register a New Customer Account", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/accounts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Registers a new customer account with Avalara through a partner integration." }, { "info": { "name": "Avalara Get Account Details", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/accounts/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Avalara Get Account Details" }, { "info": { "name": "Avalara AccountResetLicenseKey", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/accounts/:id/resetlicensekey", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Resets the existing license key for this account to a new key.\n \nTo reset your account, you must specify the ID of the account you wish to reset and confirm the action.\n \nThis API is only available to account administrators for the account in question, and may only be called after\nan account has been activated by reading and accepting Avalara's terms and conditions. To activate your account\nplease log onto the AvaTax website or call the `ActivateAccount` API.\n \n" }, { "info": { "name": "Avalara ActivateAccount", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/accounts/:id/activate", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Activate the account specified by the unique accountId number.\n \nThis activation request can only be called by account administrators. You must indicate\nthat you have read and accepted Avalara's terms and conditions to call this API.\n \nOnce you have activated your account, use the `AccountResetLicenseKey` API to generate\na license key for your account.\n \nIf you have not read or accepted the terms and conditions, this API call will return the\nunchanged account mo" }, { "info": { "name": "Avalara AuditAccount", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/accounts/:id/audit", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve audit trace history for an account.\n \nYour audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate\nproblems and see exactly what information was sent back and forth between your code and AvaTax.\n \nWhen specifying a start and end datetime, please include a valid timezone indicator, such as the \"Z\" present in the examples for the start and end query parameters.\nYou can learn" }, { "info": { "name": "Avalara CreateLicenseKey", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/accounts/:id/licensekey", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a new license key for this account.\n \nTo create a license key for your account, you must specify the ID of the account and license key name.\n \nThis API is only available to account administrators for the account in question, and may only be called after\nan account has been activated by reading and accepting Avalara's terms and conditions. To activate your account\nplease log onto the AvaTax website or call the `ActivateAccount` API.\n \nYou will reference t" }, { "info": { "name": "Avalara GetLicenseKey", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/accounts/:id/licensekey/:licensekeyname", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "licensekeyname", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, { "info": { "name": "Avalara DeleteLicenseKey", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/accounts/:id/licensekey/:licensekeyname", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "licensekeyname", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes the license key for this account using license key name.\n \nTo delete a license key for your account, you must specify the accountID of the account and license key name.\n \nThis API is only available to account administrators for the account in question.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara GetAccountConfiguration", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/accounts/:id/configuration", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a list of all configuration settings tied to this account.\n \nConfiguration settings provide you with the ability to control features of your account and of your\ntax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for\nAvalara internal software configuration values; to store your own account-level settings, please\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\n \nAccount settings are perman" }, { "info": { "name": "Avalara SetAccountConfiguration", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/accounts/:id/configuration", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update configuration settings tied to this account.\n \nConfiguration settings provide you with the ability to control features of your account and of your\ntax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for\nAvalara internal software configuration values; to store your own account-level settings, please\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\n \nAccount settings are permanent settings tha" }, { "info": { "name": "Avalara GetLicenseKeys", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/accounts/:id/licensekeys", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Gets list of all the license keys used by the account.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" } ] } ], "bundled": true }