{
  "opencollection": "1.0.0",
  "info": {
    "name": "Avalara Batches API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Batches",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Avalara List Batches for a Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.avatax.com/api/v2/companies/:companyId/batches",
            "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 Batches for a Company"
        },
        {
          "info": {
            "name": "Avalara Create a New Batch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://rest.avatax.com/api/v2/companies/:companyId/batches",
            "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 a New Batch"
        },
        {
          "info": {
            "name": "Avalara CancelBatch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://rest.avatax.com/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": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Marks the in progress batch identified by this URL as cancelled.\n            \nOnly JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message.\n            \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.\nCancelling an in progress batch does not delete any transactions that were created before the cancellation.\n            \nBecause the batch sy"
        },
        {
          "info": {
            "name": "Avalara CreateTransactionBatch",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://rest.avatax.com/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": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a new transaction batch objects attached to this company.\n            \nWhen a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be\nprocessed as quickly as possible in the order it was received. To check the\nstatus of a batch, fetch the batch and retrieve the results of the batch\noperation.\n            \nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when "
        },
        {
          "info": {
            "name": "Avalara GetBatch",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.avatax.com/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"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get the batch object identified by this URL. A batch object is a large\ncollection of API calls stored in a compact file.\n            \nUse this endpoint to retrieve the results or check the status of a batch.\n            \nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\nprocessed as quickly as possible in the order it was received. To check the\nstatus of a batch, fetch the batch and retrieve the results of the batch\noperation.\n            \nBecause the batch system proces"
        },
        {
          "info": {
            "name": "Avalara DeleteBatch",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://rest.avatax.com/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"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Marks the batch identified by this URL as deleted.\n            \nIf you attempt to delete a batch that is being processed, you will receive an error message.\nDeleting a batch does not delete any transactions that were created by importing the batch.\n            \nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use t"
        },
        {
          "info": {
            "name": "Avalara DownloadBatch",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.avatax.com/api/v2/companies/:companyId/batches/:batchId/files/:id/attachment",
            "headers": [
              {
                "name": "X-Avalara-Client",
                "value": "AvaTax Postman Collection"
              }
            ],
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "batchId",
                "value": "",
                "type": "path"
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Download a single batch file identified by this URL.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.\n"
        },
        {
          "info": {
            "name": "Avalara QueryBatches",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://rest.avatax.com/api/v2/batches",
            "headers": [
              {
                "name": "X-Avalara-Client",
                "value": "AvaTax Postman Collection"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get multiple batch objects across all companies.\n            \nA batch object is a large collection of API calls stored in a compact file.\n            \nSearch for specific objects using the criteria in the `$filter` parameter;\nfull documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\nPaginate results using the `$top`, `$skip`, and `$orderby` parameters.\n            \nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\npr"
        }
      ]
    }
  ],
  "bundled": true
}