# ImportHeadersController_GetByFilter

Gets import job headers.

`GET /api/v1/ImportHeaders/GetByFilter`

**API:** Excise Platform API
**Tag:** ImportHeadersController
**API Version:** v1
**Base URL:** https://excise.avalara.com
**Accepts:** `application/json`
**Authentication:** Basic (username + license key)

Source: https://developer.avalara.com/products/excise/api/methods/ImportHeadersController/ImportHeadersController_GetByFilter/

## Description

Retrieves a filtered and paginated list of import job headers. You can filter by load ID, status,
description, batch counts, record counts, processing time, and unassigned document ID.
            
Use the offset and limit parameters to paginate through large result sets, and the sort parameter
to control the ordering of results.

## Parameters

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `x-company-id` | integer | header | Yes | Company ID that owns the data. |
| `X-Avalara-Client` | string | header | No | Identifies the software you are using to call this API. For more information on the client header, see Client Headers. |
| `loadId` | string | query | No | The job load ID. |
| `statusInd` | string | query | No | The job status |
| `description` | string | query | No | The job description |
| `totalBatches` | integer | query | No | The total number of import batches |
| `totalPassedBatches` | integer | query | No | The number of batches with a status of Passed. |
| `totalFailedBatches` | integer | query | No | The number of batches with a status of Failed. |
| `totalSourceRecords` | integer | query | No | The number of records in the source file |
| `totalInsertedRecords` | integer | query | No | The number of records inserted |
| `processTimeElapsedSeconds` | integer | query | No | The elapsed time for the import in seconds |
| `unassignedDocumentId` | integer | query | No | The unassigned transaction file id |
| `sort` | string | query | No | Specifies the sort criteria for the results. |
| `offset` | integer | query | No | Specifies the number of rows to skip before returning results. |
| `limit` | integer | query | No | Specifies the maximum number of results to return. |

## Responses

| Status | Description | Schema |
|---|---|---|
| 200 | Returns a collection of import job headers that match the specified filters. | `Avalara.Excise.Website.Api.ApiCollectionResponse[Avalara.Excise.Common.Contracts.BusinessObjects.StImportHeaderDC]` |

### 200 Response: `Avalara.Excise.Website.Api.ApiCollectionResponse[Avalara.Excise.Common.Contracts.BusinessObjects.StImportHeaderDC]`

| Property | Type | Required | Description |
|---|---|---|---|
| `Offset` | integer | No |  Example: `0`. |
| `Limit` | integer | No |  Example: `0`. |
| `Data` | Avalara.Excise.Common.Contracts.BusinessObjects.StImportHeaderDC[] | No |  |
| `Total` | integer | No |  Example: `0`. |
| `Errors` | string[] | No |  |

## Example Request

```bash
curl -X GET "https://excise.avalara.com/api/v1/ImportHeaders/GetByFilter" \
  -H "Authorization: Basic <credentials>" \
  -H "Accept: application/json"
```