Avalara

opencollection: 1.0.0
info:
  name: Avalara AvaTax APIs
  version: 1.0.0
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: Avalara AccountResetLicenseKey
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/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: '{}'
    docs: "Resets the existing license key for this account to a new key.\r\n            \r\nTo reset your account, you must\
      \ specify the ID of the account you wish to reset and confirm the action.\r\n            \r\nThis API is only available\
      \ to account administrators for the account in question, and may only be called after\r\nan account has been activated\
      \ by reading and accepting Avalara's terms and conditions.  To activate your account\r\nplease log onto the AvaTax website\
      \ or call the `ActivateAccount` API.\r\n      "
  - info:
      name: Avalara ActivateAccount
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/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: '{}'
    docs: "Activate the account specified by the unique accountId number.\r\n            \r\nThis activation request can only\
      \ be called by account administrators.  You must indicate\r\nthat you have read and accepted Avalara's terms and conditions\
      \ to call this API.\r\n            \r\nOnce you have activated your account, use the `AccountResetLicenseKey` API to\
      \ generate\r\na license key for your account.\r\n            \r\nIf you have not read or accepted the terms and conditions,\
      \ this API call will return the\r\nunchanged a"
  - info:
      name: Avalara AuditAccount
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/accounts/:id/audit
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: "Retrieve audit trace history for an account.\r\n            \r\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\r\nproblems\
      \ and see exactly what information was sent back and forth between your code and AvaTax.\r\n            \r\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.\r\nYou can"
  - info:
      name: Avalara CreateLicenseKey
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/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: '{}'
    docs: "Creates a new license key for this account.\r\n            \r\nTo create a license key for your account, you must\
      \ specify the ID of the account and license key name.\r\n            \r\nThis API is only available to account administrators\
      \ for the account in question, and may only be called after\r\nan account has been activated by reading and accepting\
      \ Avalara's terms and conditions.  To activate your account\r\nplease log onto the AvaTax website or call the `ActivateAccount`\
      \ API.\r\n            \r\nYou will ref"
  - info:
      name: Avalara GetLicenseKey
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/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
    docs: '


      ### Security Policies


      * 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.

      '
  - info:
      name: Avalara DeleteLicenseKey
      type: http
    http:
      method: DELETE
      url: http://{{baseurl}}/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
    docs: "Deletes the license key for this account using license key name.\r\n            \r\nTo delete a license key for\
      \ your account, you must specify the accountID of the account and license key name.\r\n            \r\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 GetAccount
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/accounts/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: "Get the account object identified by this URL.\r\nYou may use the '$include' parameter to fetch additional nested\
      \ data:\r\n            \r\n* Subscriptions\r\n* Users\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, TechnicalSupportAd"
  - info:
      name: Avalara GetAccountConfiguration
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/accounts/:id/configuration
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: "Retrieve a list of all configuration settings tied to this account.\r\n            \r\nConfiguration settings provide\
      \ you with the ability to control features of your account and of your\r\ntax software.  The category names `TaxServiceConfig`\
      \ and `AddressServiceConfig` are reserved for\r\nAvalara internal software configuration values; to store your own account-level\
      \ settings, please\r\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\r\n     \
      \       \r\nAccount settings are"
  - info:
      name: Avalara SetAccountConfiguration
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/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: '{}'
    docs: "Update configuration settings tied to this account.\r\n            \r\nConfiguration settings provide you with\
      \ the ability to control features of your account and of your\r\ntax software.  The category names `TaxServiceConfig`\
      \ and `AddressServiceConfig` are reserved for\r\nAvalara internal software configuration values; to store your own account-level\
      \ settings, please\r\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\r\n     \
      \       \r\nAccount settings are permanent setti"
  - info:
      name: Avalara GetLicenseKeys
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/accounts/:id/licensekeys
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: 'Gets list of all the license keys used by the account.


      ### Security Policies


      * 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.

      '
  - info:
      name: Avalara QueryAccounts
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/accounts
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
    docs: "List all account objects that can be seen by the current user.\r\n            \r\nThis API lists all accounts you\
      \ are allowed to see.  In general, most users will only be able to see their own account.\r\n            \r\nSearch\
      \ for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering\
      \ in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`,\
      \ and `$orderby` parameters.\r\nYou may specify one o"
- info:
    name: Registrar
    type: folder
  items:
  - info:
      name: Avalara UpdateAccount
      type: http
    http:
      method: PUT
      url: http://{{baseurl}}/api/v2/accounts/:id
      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: '{}'
    docs: "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n           \
      \ \r\nReplace an existing account object with an updated account object.\n\n### Security Policies\n\n* This API requires\
      \ one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n"
  - info:
      name: Avalara DeleteAccount
      type: http
    http:
      method: DELETE
      url: http://{{baseurl}}/api/v2/accounts/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n           \
      \ \r\nDelete an account.\r\nDeleting an account will delete all companies, all account level users and license keys\
      \ attached to this account.\n\n### Security Policies\n\n* This API requires the user role SystemAdmin.\n"
  - info:
      name: Avalara CreateAccount
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/accounts
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      body:
        type: json
        data: '{}'
    docs: "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n           \
      \ \r\nCreate a single new account object.\r\nWhen creating an account object you may attach subscriptions and users\
      \ as part of the 'Create' call.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin,\
      \ FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n"
  - info:
      name: Avalara UpdateNotification
      type: http
    http:
      method: PUT
      url: http://{{baseurl}}/api/v2/notifications/:id
      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: '{}'
    docs: "This API is available by invitation only.\r\n            \r\nReplaces the notification identified by this URL with\
      \ a new notification.\r\n            \r\nA notification is a message from Avalara that may have relevance to your business.\
      \  You may want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\
      \nany relevant concerns raised by this notification.\r\n            \r\nAn example of a notification would be a message\
      \ about new software, or a change to AvaTa"
  - info:
      name: Avalara DeleteNotification
      type: http
    http:
      method: DELETE
      url: http://{{baseurl}}/api/v2/notifications/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: "This API is available by invitation only.\r\n            \r\nDelete the existing notification identified by this\
      \ URL.\r\n            \r\nA notification is a message from Avalara that may have relevance to your business.  You may\
      \ want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\nany\
      \ relevant concerns raised by this notification.\r\n            \r\nAn example of a notification would be a message\
      \ about new software, or a change to AvaTax that may\r\naffec"
  - info:
      name: Avalara CreateNotifications
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/notifications
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      body:
        type: json
        data: '{}'
    docs: "This API is available by invitation only.\r\n            \r\nCreate a single notification.\r\n            \r\n\
      A notification is a message from Avalara that may have relevance to your business.  You may want\r\nto regularly review\
      \ notifications and then dismiss them when you are certain that you have addressed\r\nany relevant concerns raised by\
      \ this notification.\r\n            \r\nA Global notification is a message which is directed to all the accounts and\
      \ is set to expire within\r\na certain time and cannot be d"
  - info:
      name: Avalara CreateSubscriptions
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/accounts/:accountId/subscriptions
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: "This API is for use by Avalara Registrar administrative users only.\r\n            \r\nCreate one or more new subscription\
      \ objects attached to this account.\r\nA 'subscription' indicates a licensed subscription to a named Avalara service.\r\
      \nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.\n\n### Security\
      \ Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin,\
      \ SystemAdmin, TechnicalSupportAdmin.\n"
  - info:
      name: Avalara UpdateSubscription
      type: http
    http:
      method: PUT
      url: http://{{baseurl}}/api/v2/accounts/:accountId/subscriptions/:id
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n           \
      \ \r\nReplace the existing subscription object at this URL with an updated object.\r\nA 'subscription' indicates a licensed\
      \ subscription to a named Avalara service.\r\nTo request or remove subscriptions, please contact Avalara sales or your\
      \ customer account manager.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\
      \nTo set a field's value to null, you may either s"
  - info:
      name: Avalara DeleteSubscription
      type: http
    http:
      method: DELETE
      url: http://{{baseurl}}/api/v2/accounts/:accountId/subscriptions/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n           \
      \ \r\nMark the existing account identified by this URL as deleted.\n\n### Security Policies\n\n* This API requires one\
      \ of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n"
  - info:
      name: Avalara ListServiceTypes
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/servicetypes/servicetypes
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
    docs: "For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n            \r\
      \nReturns the full list of Avalara-supported subscription types.\r\nThis API is intended to be useful for identifying\
      \ which features you have added to your account.\r\nYou may always contact Avalara's sales department for information\
      \ on available products or services.\r\nYou cannot change your subscriptions/service directly through the API.\n\n###\
      \ Security Policies\n\n* This API requires one of the fol"
  - info:
      name: Avalara ResetPassword
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/passwords/:userId/reset
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: userId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n           \
      \ \r\nAllows a system admin to reset the password for a specific user via the API.\r\nThis API is only available for\
      \ Avalara Registrar Admins, and can be used to reset the password of any\r\nuser based on internal Avalara business\
      \ processes.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser,\
      \ BatchServiceAdmin, CompanyAdmin, CompanyUser, Complianc"
- info:
    name: Addresses
    type: folder
  items:
  - info:
      name: Avalara ResolveAddress
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/addresses/resolve
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
    docs: "Resolve an address against Avalara's address-validation system.  If the address can be resolved, this API\r\nprovides\
      \ the latitude and longitude of the resolved location.  The value 'resolutionQuality' can be used\r\nto identify how\
      \ closely this address can be located.  If the address cannot be clearly located, use the\r\n'messages' structure to\
      \ learn more about problems with this address.\r\nThis is the same API as the POST /api/v2/addresses/resolve endpoint.\r\
      \nBoth verbs are supported to provide for fl"
  - info:
      name: Avalara ResolveAddressPost
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/addresses/resolve
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      body:
        type: json
        data: '{}'
    docs: "Resolve an address against Avalara's address-validation system.  If the address can be resolved, this API\r\nprovides\
      \ the latitude and longitude of the resolved location.  The value 'resolutionQuality' can be used\r\nto identify how\
      \ closely this address can be located.  If the address cannot be clearly located, use the\r\n'messages' structure to\
      \ learn more about problems with this address.\r\nThis is the same API as the GET /api/v2/addresses/resolve endpoint.\r\
      \nBoth verbs are supported to provide for fle"
- info:
    name: AdvancedRules
    type: folder
  items:
  - info:
      name: Avalara GetCompanyLookupFiles
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/advancedrules/accounts/:accountId/companies/:companyId/lookupFiles
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      - name: companyId
        value: ''
        type: path
    docs: Avalara GetCompanyLookupFiles
  - info:
      name: Avalara CreateCompanyLookupFile
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/advancedrules/accounts/:accountId/companies/:companyId/lookupFiles
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      - name: companyId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Avalara CreateCompanyLookupFile
  - info:
      name: Avalara GetLookupFile
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/advancedrules/accounts/:accountId/lookupFiles/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: Avalara GetLookupFile
  - info:
      name: Avalara UpdateLookupFile
      type: http
    http:
      method: PUT
      url: http://{{baseurl}}/api/v2/advancedrules/accounts/:accountId/lookupFiles/:id
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Avalara UpdateLookupFile
  - info:
      name: Avalara DeleteLookupFile
      type: http
    http:
      method: DELETE
      url: http://{{baseurl}}/api/v2/advancedrules/accounts/:accountId/lookupFiles/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: accountId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: Avalara DeleteLookupFile
- info:
    name: AvaFileForms
    type: folder
  items:
  - info:
      name: Avalara QueryAvaFileForms
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/avafileforms
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
    docs: "Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering\
      \ in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`,\
      \ and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin,\
      \ AccountOperator, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin,\
      \ ComplianceUser, Firm"
  - info:
      name: Avalara CreateAvaFileForms
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/avafileforms
      headers:
      - name: Content-Type
        value: application/json
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      body:
        type: json
        data: '{}'
    docs: "Create one or more AvaFileForms\r\nA 'AvaFileForm' represents a form supported by our returns team\n\n### Security\
      \ Policies\n\n* This API requires the user role Compliance Root User.\n* This API depends on the following active services:*Returns*\
      \ (at least one of):  Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm):  ARA, ARAManaged.\n"
  - info:
      name: Avalara GetAvaFileForm
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/avafileforms/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: 'Get the AvaFileForm object identified by this URL.


      ### Security Policies


      * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin,
      CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin,
      TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.

      * This API depends on the following active services:*Returns* (at least one of):  Mrs, MRSComplianceManager, AvaTaxCsp.*Firm'
  - info:
      name: Avalara UpdateAvaFileForm
      type: http
    http:
      method: PUT
      url: http://{{baseurl}}/api/v2/avafileforms/:id
      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: '{}'
    docs: "All data from the existing object will be replaced with data in the object you PUT.\r\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 the user role Compliance Root User.\n* This API depends on the following active services:*Returns*\
      \ (at least one of):  Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm):  ARA, ARAManaged.\n"
  - info:
      name: Avalara DeleteAvaFileForm
      type: http
    http:
      method: DELETE
      url: http://{{baseurl}}/api/v2/avafileforms/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: id
        value: ''
        type: path
    docs: 'Marks the existing AvaFileForm object at this URL as deleted.


      ### Security Policies


      * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.

      * This API depends on the following active services:*Returns* (at least one of):  Mrs, MRSComplianceManager, AvaTaxCsp.*Firm
      Managed* (for accounts managed by a firm):  ARA, ARAManaged.

      '
- info:
    name: Batches
    type: folder
  items:
  - info:
      name: Avalara CancelBatch
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/companies/:companyId/batches/:id/cancel
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: companyId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: "Marks the in progress batch identified by this URL as cancelled.\r\n            \r\nOnly JSON batches can be cancelled. If\
      \ you attempt to cancel a file batch, you will receive an error message.\r\n            \r\nOnly in progress batches\
      \ can be cancelled.  If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive\
      \ an error message.\r\nCancelling an in progress batch does not delete any transactions that were created before the\
      \ cancellation.\r\n            \r\nBecause the b"
  - info:
      name: Avalara ListBatchesByCompany
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/companies/:companyId/batches
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: companyId
        value: ''
        type: path
    docs: "List all batch objects attached to the specified company.\r\n            \r\nA batch object is a large collection\
      \ of API calls stored in a compact file.\r\n            \r\nSearch for specific objects using the criteria in the `$filter`\
      \ parameter;\r\nfull documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)\
      \ .\r\nPaginate results using the `$top`, `$skip`, and `$orderby` parameters.\r\n            \r\nUse [GetBatch](https://developer.avalara.com/api-reference/a"
  - info:
      name: Avalara CreateBatches
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/companies/:companyId/batches
      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: '{}'
    docs: "Create one or more new batch objects attached to this company.\r\n            \r\nEach batch object may have one\
      \ or more file objects (currently only one file is supported).\r\n            \r\nWhen a batch is created, it is added\
      \ to the AvaTax Batch Queue and will be\r\nprocessed as quickly as possible in the order it was received. To check the\r\
      \nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n            \r\nBecause\
      \ the batch system processes with a degree of concurrenc"
  - info:
      name: Avalara CreateTransactionBatch
      type: http
    http:
      method: POST
      url: http://{{baseurl}}/api/v2/companies/:companyId/batches/transactions
      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: '{}'
    docs: "Create a new transaction batch objects attached to this company.\r\n            \r\nWhen a transaction batch is\
      \ created, it is added to the AvaTax Batch v2 Queue and will be\r\nprocessed as quickly as possible in the order it\
      \ was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\
      \n            \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in\
      \ the queue vary, AvaTax API is unable to accurately\r\npred"
  - info:
      name: Avalara GetBatch
      type: http
    http:
      method: GET
      url: http://{{baseurl}}/api/v2/companies/:companyId/batches/:id
      headers:
      - name: X-Avalara-Client
        value: AvaTax Postman Collection
      params:
      - name: companyId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: "Get the batch object identified by this URL. A batch object is a large\r\ncollection of API calls stored in a compact\
      \ file.\r\n            \r\nUse this endpoint to retrieve the results or check the status of a batch.\r\n           \
      \ \r\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\r\nprocessed as quickly a

# --- truncated at 32 KB (300 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/apis.yml