# Excise Platform API

Source: https://developer.avalara.com/products/excise/api/

**Version:** v1
**Base URL:** https://excise.avalara.com

---

## Endpoints

### AlternateProductsController

#### Creates an alternate product record.

`POST /api/v1/AlternateProducts/Create`

Creates a new alternate product code record. The alternate product is validated and sanitized
before insertion.

**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. |
| `request` |  | body | Yes | The alternate product to create. |

#### Updates an existing alternate product record.

`PUT /api/v1/AlternateProducts/Update`

Updates an existing alternate product code record. The record is looked up by its composite
primary key.

**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. |
| `request` |  | body | Yes | The alternate product to update. |

#### Deletes an existing alternate product record.

`DELETE /api/v1/AlternateProducts/Delete`

Deletes an existing alternate product code record. The record is looked up by its composite
primary key.

**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. |
| `request` |  | body | Yes | The alternate product to delete. |


### AvaTaxExciseController

#### Creates and calculates taxes for an AvaTax Excise transaction.

`POST /api/v1/AvaTaxExcise/transactions/create`

Creates a new AvaTax Excise transaction and calculates the applicable taxes. The transaction
is processed by the determination engine and the calculated tax results are returned.

**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. |
| `transaction` |  | body | Yes | An AvaTax Excise transaction. |
| `include` | string | query | No | Specifies one or more options to include additional nested data in the response. Separate multiple values with commas. |

#### Alters and recalculates taxes for an existing AvaTax Excise transaction.

`POST /api/v1/AvaTaxExcise/transactions/createoradjust`

Creates a new transaction or adjusts an existing one, then recalculates the applicable taxes.
If a transaction with the same transaction code already exists, it is adjusted; otherwise a new
transaction is created.

**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. |
| `request` |  | body | Yes | The transaction adjustment request. |
| `include` | string | query | No | Specifies one or more options to include additional nested data in the response. Separate multiple values with commas. |

#### Alters and recalculates taxes for an existing AvaTax Excise transaction.

`POST /api/v1/AvaTaxExcise/transactions/{transactionCode}/adjust`

Adjusts an existing transaction identified by the transaction code and recalculates the applicable taxes.
The adjustment request contains the corrected transaction data that replaces the original.

**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. |
| `request` |  | body | Yes | The corrected transaction. |
| `transactionCode` | string | path | Yes | The unique value that identifies a transaction. |
| `include` | string | query | No | Specifies one or more options to include additional nested data in the response. Separate multiple values with commas. |

#### Commits an existing AvaTax Excise transaction.

`POST /api/v1/AvaTaxExcise/transactions/{transactionCode}/commit`

Commits a previously created AvaTax Excise transaction, making it final. Once committed,
the transaction is locked and can only be voided, not further adjusted.

**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. |
| `transactionCode` | string | path | Yes | The unique value that identifies a transaction. |
| `include` | string | query | No | Specifies one or more options to include additional nested data in the response. Separate multiple values with commas. |

#### Voids a committed AvaTax Excise transaction.

`POST /api/v1/AvaTaxExcise/transactions/{transactionCode}/void`

Voids a previously committed AvaTax Excise transaction. Voiding reverses the tax effects
of the transaction while preserving the transaction record for audit purposes.

**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. |
| `transactionCode` | string | path | Yes | The unique value that identifies a transaction. |
| `include` | string | query | No | Specifies one or more options to include additional nested data in the response. Separate multiple values with commas. |

#### Updates the tax return data for the specified transaction.

`POST /api/v1/AvaTaxExcise/transactions/{transactionCode}/updatereturndata`

Updates the tax return data for an existing transaction identified by the transaction code.
This allows correction of return-specific fields without recalculating the entire transaction.

**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. |
| `request` |  | body | Yes | The updated tax return data. |
| `transactionCode` | string | path | Yes | The unique value that identifies a transaction. |
| `include` | string | query | No | Specifies one or more options to include additional nested data in the response. Separate multiple values with commas. |

#### Calculates taxes for an array of AvaTax Excise transactions.

`POST /api/v1/AvaTaxExcise/ProcessTransactions`

Submits an array of transactions for tax calculation. Each transaction is processed by the
determination engine and tax results are returned for all submitted transactions.
            
The number of transactions in a single request is limited by a configurable maximum transaction count.

**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. |
| `transactions` | array | body | Yes | An array of transactions to process. |
| `include` | string | query | No | Specifies one or more options to include additional nested data in the response. Separate multiple values with commas. |


### ImportBusinessEntitiesController

#### Upload a license image for a business account.

`POST /api/v1/ImportBusinessEntities/UploadImage/{accountId}`

Uploads a license image file for the specified business account. The file must be a valid image type
as defined by the site settings. If the business account already has a license image, the previous
image is replaced and the old file is removed from storage.
            
The request must be a multipart/form-data request containing exactly one image file.

**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. |
| `accountId` | integer | path | Yes | The ID of the business account |

#### Import business entities and associated business accounts.

`POST /api/v1/ImportBusinessEntities/ImportBusinessEntities`

Imports business entity records and their associated business accounts into the Excise Platform.
The import engine processes the provided entities and returns a summary of the results including
inserted, updated, and failed records.
            
The request supports options for matching existing business entities and controlling whether
new records are terminated and whether all account types are created.

**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. |
| `request` |  | body | Yes | The business entity import request. |

#### Import business entities and associated business accounts.

`PUT /api/v1/ImportBusinessEntities/ImportBusinessEntities`

Imports business entity records and their associated business accounts into the Excise Platform.
The import engine processes the provided entities and returns a summary of the results including
inserted, updated, and failed records.
            
The request supports options for matching existing business entities and controlling whether
new records are terminated and whether all account types are created.

**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. |
| `request` |  | body | Yes | The business entity import request. |

#### Delete unlocked or unused business entities and associated business accounts.

`DELETE /api/v1/ImportBusinessEntities/DeleteBusinessEntity`

Permanently deletes a business entity and its associated business accounts by the entity's unique identifier.
The entity must belong to the current master company and must not be locked or in use by profiles,
scenarios, or business profile details. Associated location cross-references and comments are also deleted.

**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. |
| `businessEntityId` | integer | query | Yes | The unique identifier of the business entity to delete. |


### ImportHeadersController

#### Gets an import job.

`GET /api/v1/ImportHeaders/Get`

Retrieves the details of a single import job by its load ID. Returns information such as the job status,
total batches, source records, inserted records, and processing time.

**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 | Yes | The job load ID. |

#### Gets import job headers.

`GET /api/v1/ImportHeaders/GetByFilter`

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

#### Gets import job headers by load date or deleted date.

`GET /api/v1/ImportHeaders/GetByLoadDate`

Retrieves a filtered and paginated list of import job headers based on the date the job was loaded
or deleted. You can also filter by job status.
            
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. |
| `loadOnDate` | string | query | No | Date the job was loaded (UTC) |
| `deletedOnDate` | string | query | No | Date the job was deleted (UTC) |
| `statusInd` | string | query | No | Status of the job |
| `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. |

#### Downloads the unassigned schedule transaction file for an import.

`GET /api/v1/ImportHeaders/DownloadUnassignedFile`

Downloads a ZIP file containing the unassigned schedule transactions for the specified import job.
If no unassigned transactions exist for the given load ID, an empty response is returned.

**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 | Yes | The job load ID. |


### ImportItemCodesController

#### Imports item codes.

`POST /api/v1/ImportItemCodes/ImportItemCodes`

Imports item code records into the Excise Platform. The import engine processes the provided
item codes and returns a summary of the results including inserted, updated, and failed records.

**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. |
| `request` |  | body | Yes | The item code import request. |

#### Imports item codes.

`PUT /api/v1/ImportItemCodes/ImportItemCodes`

Imports item code records into the Excise Platform. The import engine processes the provided
item codes and returns a summary of the results including inserted, updated, and failed records.

**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. |
| `request` |  | body | Yes | The item code import request. |

#### Deletes an item code.

`DELETE /api/v1/ImportItemCodes/DeleteItemCode`

Permanently deletes an item code by its unique identifier. The item code must belong to the current
master company and must not be locked.

**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. |
| `itemCodeId` | integer | query | Yes | The unique identifier of the item code to delete. |


### ImportLocationsController

#### Imports locations.

`POST /api/v1/ImportLocations/ImportLocations`

Imports location records into the Excise Platform. The import engine processes the provided
locations and returns a summary of the results including inserted, updated, and failed records.
            
The request supports options for matching existing locations by various fields such as country code,
jurisdiction, description, address, airport code, and more.

**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. |
| `request` |  | body | Yes | The location import request. |

#### Imports locations.

`PUT /api/v1/ImportLocations/ImportLocations`

Imports location records into the Excise Platform. The import engine processes the provided
locations and returns a summary of the results including inserted, updated, and failed records.
            
The request supports options for matching existing locations by various fields such as country code,
jurisdiction, description, address, airport code, and more.

**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. |
| `request` |  | body | Yes | The location import request. |

#### Deletes a location.

`DELETE /api/v1/ImportLocations/DeleteLocation`

Permanently deletes a location by its unique identifier. The location must belong to the current
master company and must not be locked or in use by profiles, scenarios, cross-references, or company accounts.
Associated location alternates and special jurisdictions are also deleted.

**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. |
| `locationId` | integer | query | Yes | The unique identifier of the location to delete. |


### ImportManufacturersController

#### Imports manufacturers.

`POST /api/v1/ImportManufacturers/ImportManufacturers`

Imports manufacturer records into the Excise Platform. The import engine processes the provided
manufacturers and returns a summary of the results including inserted, updated, and failed records.
            
The request supports options for matching existing manufacturers and controlling how jurisdiction
data is updated during the import.

**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. |
| `request` |  | body | Yes | The manufacturer import request. |

#### Imports manufacturers.

`PUT /api/v1/ImportManufacturers/ImportManufacturers`

Imports manufacturer records into the Excise Platform. The import engine processes the provided
manufacturers and returns a summary of the results including inserted, updated, and failed records.
            
The request supports options for matching existing manufacturers and controlling how jurisdiction
data is updated during the import.

**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. |
| `request` |  | body | Yes | The manufacturer import request. |


### ImportProductsTobaccoController

#### Import tobacco products.

`POST /api/v1/ImportProductsTobacco/ImportProductsTobacco`

Imports tobacco product records into the Excise Platform. The import engine processes the provided
tobacco products and returns a summary of the results including inserted, updated, and failed records.
            
If manufacturer assignment is enabled, manufacturers are imported first and linked to their
corresponding tobacco products before the product import is executed.

**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. |
| `request` |  | body | Yes | The tobacco product import request. |

#### Import tobacco products.

`PUT /api/v1/ImportProductsTobacco/ImportProductsTobacco`

Imports tobacco product records into the Excise Platform. The import engine processes the provided
tobacco products and returns a summary of the results including inserted, updated, and failed records.
            
If manufacturer assignment is enabled, manufacturers are imported first and linked to their
corresponding tobacco products before the product import is executed.

**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. |
| `request` |  | body | Yes | The tobacco product import request. |

#### Deletes a tobacco product.

`DELETE /api/v1/ImportProductsTobacco/DeleteProductTobacco`

Permanently deletes a tobacco product by its unique identifier. The product must belong to the
current master company and must not be locked.

**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. |
| `ProductTobaccoId` | integer | query | Yes | The unique identifier of the tobacco product to delete. |


### ImportScheduleTransactionsController

#### Schedule transaction import upload.

`POST /api/v1/ImportScheduleTransactions/Upload`

Accepts a multipart file upload containing schedule transaction data. The uploaded file is stored
and a scheduled task is created to process the import asynchronously.
            
Monitor the System Activity Logs for processing status and 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. |

#### Schedule transaction import upload.

`PUT /api/v1/ImportScheduleTransactions/Upload`

Accepts a multipart file upload containing schedule transaction data. The uploaded file is stored
and a scheduled task is created to process the import asynchronously.
            
Monitor the System Activity Logs for processing status and 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. |

#### Imports schedule transactions.

`POST /api/v1/ImportScheduleTransactions/ImportScheduleTransactions`

Accepts a JSON request containing schedule transaction records to import. The request is serialized
and stored, then a scheduled task is created to process the import asynchronously.
            
The import supports batching - multiple batches can be sent with the same load ID. Options include
business entity matching, location matching, tobacco product matching, manufacturer matching,
workflow reset, and email notifications at various import steps.
            
Monitor the System Activity Logs for processing status and 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. |
| `request` |  | body | Yes | The schedule transaction import request. |


### JurisdictionsController

#### Gets a list of jurisdictions licensed for returns for the current master company and user.

`GET /api/v1/Jurisdictions/GetAcceptableJurisdictionsForGivenCountry`

Returns the list of jurisdictions that are licensed for Returns for the specified country code.
Only jurisdictions accessible to the current user and master company are included.

**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. |
| `countryCode` | string | query | Yes | The country code used to retrieve acceptable jurisdictions. |


### NotificationController

#### Requests that a notification message be sent.

`GET /api/v1/Notification/RequestNotification`

Sends a notification email to the specified recipient with information about an import job.
The notification includes the import step, job status, summary, and description details.
            
Returns true if the email was sent successfully, or false otherwise.

**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. |
| `messageRecipient` | string | query | Yes | The recipient of the notification message. |
| `importStep` | integer | query | Yes | The import step associated with the notification. |
| `status` | string | query | Yes | The status associated with the notification. |
| `jobSummary` | string | query | Yes | The summary information for the job included in the notification. |
| `jobDescription` | string | query | Yes | The detailed description of the job included in the notification. |


### RatesController

#### Gets a list of licensed rates that have been changed since the specified date.

`GET /api/v1/Rates/GetChangedRates`

Returns all licensed rates that have been modified since the specified start date. Results can be
optionally filtered by country code, jurisdiction, tax type, rate subtype, and master company ID.
            
This endpoint is useful for keeping an external system in sync with rate changes in the Excise Platform.

**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. |
| `startDate` | string | query | Yes | The start date and time used to retrieve rates changed after this point. |
| `countryCode` | string | query | No | The country code used to filter the rates. |
| `jurisdiction` | string | query | No | The jurisdiction used to filter the rates. |
| `taxType` | string | query | No | The tax type used to filter the rates. |
| `rateSubtype` | string | query | No | The rate subtype used to filter the rates. |
| `masterCompanyId` | integer | query | No | The master company ID used to filter the rates. |


### Tax Sessions

#### Creates a tax session for the specified company.

`POST /api/v1/TaxSessions/Create`

Creates a new tax session using the provided tax session identifiers. The company must be
licensed for the specified return and properly configured. The API returns the created tax session
including the assigned HeaderId and Sequence (initially 0). This does not generate the return output.

**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. |
| `request` |  | body | Yes | The tax session creation request containing Country, Jurisdiction, TaxpayerType, StartDate, and optional TerminalCode and LocationID. |

#### Returns the list of available Tax Session fields and their data types.

`GET /api/v1/TaxSessions/Fields`

Returns metadata describing fields that can be requested using the fields parameter in Tax
Sessions APIs (GetByHeader, GLReconDetail, GLReconSummary). Use this to discover valid field
names for the fields parameter. Field names are case sensitive.

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

#### Returns tax session details for the specified HeaderId and Sequence.

`GET /api/v1/TaxSessions/GetByHeader`

Returns tax session details for a single tax session identified by HeaderId and Sequence.
Use the fields parameter to control which properties are returned. Default fields:
CompanyId, HeaderId, Country, Jurisdiction, TaxpayerType, TerminalCode, LocationID,
ReturnCode, ReturnEffectiveDate, StartDate, Sequence.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `sequence` | integer | query | No | The sequence of the specified tax session (Default: 0). |
| `fields` | string | query | No | Comma-separated list of fields to return. Use *all for all fields. Default returns a subset of key fields. |
| `quickFail` | boolean | query | No | If true, returns 400 immediately when an invalid field name is specified (Default: false). |

#### Updates editable attributes of an existing tax session.

`PUT /api/v1/TaxSessions/UpdateSettings`

Updates configurable tax session fields identified by HeaderId and Sequence. Updates are
validated against tax session state and business rules. Only fields provided in the request
body are updated. Updates are not permitted if the tax session is filed or locked.
CalculationViewInd can only be updated on Sequence > 0 (amended sessions).

**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. |
| `request` |  | body | Yes | The settings to update. Only provided fields are modified. |
| `headerId` | integer | query | Yes | The header id of the tax session to update. |
| `sequence` | integer | query | No | The sequence of the tax session to update (Default: 0). |

#### Generates the tax return for the specified tax session.

`PUT /api/v1/TaxSessions/GenerateReturn`

Triggers return calculation and generation for the tax session identified by HeaderId and
Sequence. This process updates return totals, validation status, and related output metadata.
Return generation is not permitted if the tax session is locked. If the tax session is filed,
re-generating creates a new PDF document but does not re-calculate the return.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `sequence` | integer | query | No | The sequence of the specified tax session (Default: 0). |

#### Returns return-level errors for the specified tax session from the most recent return generation.

`GET /api/v1/TaxSessions/ReturnErrors`

Returns error messages recorded during the most recent return generation process for the tax
session identified by HeaderId and Sequence. Errors of type Critical (C), Warning (W), and
Informational (I) are included. A tax return cannot be filed when a Critical error has been
identified. If the tax session has not been generated or no errors exist, an empty result set is returned.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `sequence` | integer | query | No | The sequence of the specified tax session (Default: highest sequence for the HeaderId). |

#### Triggers GL reconciliation generation for the specified tax session.

`PUT /api/v1/TaxSessions/GenerateGLRecon`

Triggers generation of General Ledger (GL) reconciliation data for the tax session identified
by HeaderId and Sequence. The GL reconciliation process applies active schedule rate records
and creates journal entries. The company account must have General Ledger Reconciliation active.
Generation is not permitted if the tax session is locked.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `sequence` | integer | query | No | The sequence of the specified tax session (Default: 0). |

#### Marks the return as filed for the specified tax session.

`PUT /api/v1/TaxSessions/FileReturn`

Files the tax return for the specified tax session. Filing is only permitted on the highest
sequence. The tax session must not have critical errors, must not be locked, and must meet
statute of limitations requirements. A filed tax session cannot be regenerated or have its
manual fields updated until it is unfiled.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `filedDate` | string | query | Yes | The date to record as the filing date. |
| `sequence` | integer | query | No | The sequence to file. If omitted, the highest sequence is used. Filing is only permitted on the highest sequence. |

#### Marks the return as un-filed for the specified tax session.

`PUT /api/v1/TaxSessions/UnFileReturn`

Unfiles the highest sequence tax return for the specified HeaderId. The highest sequence must
currently be filed. The session ownership must match the current user's back-end indicator.
Unfiling is blocked if a mass file tax sessions task is currently running.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `reason` | string | query | No | Optional reason for unfiling the tax session. |
| `unlock` | boolean | query | No | If true, also unlocks the tax session after unfiling (Default: false). |

#### Deletes the highest sequence tax session for the specified HeaderId.

`DELETE /api/v1/TaxSessions/Delete`

Queues a scheduled task to delete the highest sequence tax session for the specified HeaderId.
Deletion is not permitted if the tax session is filed. The session ownership must match the
current user's back-end indicator. Locked sessions may still be deleted.

**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. |
| `headerId` | integer | query | Yes | The header id of the tax session to delete. |

#### Creates an amended tax session with an incremented Sequence.

`POST /api/v1/TaxSessions/Amend`

Creates an amended version of the specified tax session with an incremented Sequence number.
The highest sequence must be filed before an amendment can be created. The new sequence
inherits settings from the previous sequence. The amendment type is set to "AMENDED".

**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. |
| `headerId` | integer | query | Yes | The header id of the tax session to amend. |

#### Returns manual entry field definitions for the specified tax session.

`GET /api/v1/TaxSessions/GetManualFieldDefinitions`

Returns the field names and data types of all manual entry fields configured for the return
associated with the specified tax session. Use this to discover which fields are available
for the UpdateManualFields API.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |

#### Returns manual entry field captions for the specified tax session.

`GET /api/v1/TaxSessions/GetManualFieldCaptions`

Returns the field names and their human-readable captions for all manual entry fields
configured for the return associated with the specified tax session. Use this for display
purposes when presenting manual fields to users.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |

#### Updates specified manual entry fields for the specified tax session.

`PUT /api/v1/TaxSessions/UpdateManualFields`

Updates manual entry field values for the highest sequence of the specified tax session.
The tax session must not be filed or locked. The session ownership must match the current
user's back-end indicator. Use GetManualFieldDefinitions to discover valid field names.

**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. |
| `request` |  | body | Yes | The manual fields to update as a dictionary of field name to value. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `validateOnly` | boolean | query | No | If true, validates the fields without persisting changes (Default: false). |

#### Returns grouped transaction validation errors for the specified tax session.

`GET /api/v1/TaxSessions/TransactionValidationErrors`

Returns transaction-level validation errors grouped by schedule and rule for the specified
tax session. These are distinct from return-level errors (ReturnErrors) and represent issues
found in individual schedule transactions during validation.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `sequence` | integer | query | No | The sequence (Default: highest sequence for the HeaderId). |
| `scheduleCode` | string | query | No | Optional filter by schedule code. |
| `ruleId` | integer | query | No | Optional filter by validation rule id. |
| `errorLevelInd` | string | query | No | Optional filter by error level (C, W, I). |

#### Downloads the generated tax return PDF.

`GET /api/v1/TaxSessions/DownloadReturnPDF`

Downloads the generated tax return PDF for the specified tax session. The return must have been
generated before a PDF is available. Multi-segment returns can be downloaded individually by
segment number or merged into a single PDF. The filename follows the pattern:
ReturnCode_Period_Sequence.pdf (or _Merged.pdf when merging, or _SegmentDesc.pdf for specific segments).

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `sequence` | integer | query | No | The sequence (Default: highest sequence for the HeaderId). |
| `segment` | integer | query | No | The segment number to download (Default: 1). Multi-segment returns have separate PDFs per form section. |
| `mergeSegments` | boolean | query | No | If true, merges all segments into a single PDF download (Default: false). |

#### Downloads the GL Recon Detail report.

`GET /api/v1/TaxSessions/GLReconDetail`

Downloads the General Ledger reconciliation detail report for the specified tax session as a
CSV or Excel file. The company must be licensed for GL Recon and the company account must have
General Ledger Reconciliation active. GL Recon data must be generated before downloading.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `format` | string | query | No | Export format: CSV, XLSX, or Excel (Default: CSV). Excel is treated as XLSX. |
| `fields` | string | query | No | Comma-separated list of fields to include in the export. If omitted, all fields are included. |

#### Downloads the GL Recon Summary report.

`GET /api/v1/TaxSessions/GLReconSummary`

Downloads the General Ledger reconciliation summary report for the specified tax session as a
CSV or Excel file. The company must be licensed for GL Recon and the company account must have
General Ledger Reconciliation active. GL Recon data must be generated before downloading.

**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. |
| `headerId` | integer | query | Yes | The header id of the specified tax session. |
| `format` | string | query | No | Export format: CSV, XLSX, or Excel (Default: CSV). Excel is treated as XLSX. |
| `fields` | string | query | No | Comma-separated list of fields to include in the export. If omitted, all fields are included. |


### TaxpayerTypesController

#### Gets a list of licensed taxpayer types for the current master company.

`GET /api/v1/TaxpayerTypes/GetAcceptableTaxpayerTypesForGivenJurisdictionsAndFilter`

Returns the list of taxpayer types that are valid for the specified country code and jurisdiction
within the current master company. An optional activity date can be provided to filter results
to taxpayer types that are active as of that date.

**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. |
| `countryCode` | string | query | Yes | The country code used to retrieve acceptable taxpayer types. |
| `jurisdiction` | string | query | Yes | The jurisdiction used to retrieve acceptable taxpayer types. |
| `activityDate` | string | query | No | The activity date used to filter acceptable taxpayer types. |


### UtilitiesController

#### Tests connectivity and the version of the service.

`GET /api/v1/Utilities/Ping`

Check connectivity to the Excise Platform API and return information about the API server.
            
This API is intended to help you verify that your connection is working. This API will always succeed and will
never return an error. It provides basic information about the server you connect to:
            
* `version` - The version number of the Excise Platform API server that responded to your request.
* `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request.
* `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.

**Parameters:**

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `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. |

#### Returns the company ID for the requested company name, if the user has access to that company.

`GET /api/v1/Utilities/GetCompanyId`

Looks up the company ID for a given company name. The requesting user must have access to the specified company.

**Parameters:**

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `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. |
| `companyName` | string | query | Yes | The name of the company for which to retrieve the company ID. |

#### Returns a list of all non-obsolete licensed master company IDs that the requesting user has access to as of the requested date.

`GET /api/v1/Utilities/GetMasterCompanies`

Returns a list of master company details that the requesting user has access to. Only non-obsolete, licensed
master companies are included. The effective date must not be in the future.
            
Each result includes the master company ID, name, deployment status, active status, and licensing information
for Returns Excise and AvaTax Excise products.

**Parameters:**

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `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. |
| `effectiveDate` | string | query | Yes | The effective date used to determine accessible master companies. |

---

## Models

### Avalara.Excise.Common.Contracts.Services.RestAlternateProduct

Represents an alternate product mapping for REST services, containing product codes, jurisdictions, and tax information.

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `ProductCode` | string | The product code identifier. |
| `AlternateProductCode` | string | The alternate product code mapped to the primary product for this jurisdiction. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `TerminalCode` | string | The terminal code associated with this mapping. |
| `AlternativeFuelContent` | number | The alternative fuel content for the product, when applicable. |
| `TaxCode` | string | The tax code associated with this record. |
| `Name` | string | The display name. |

### Avalara.Excise.Determination.Engine.RestTransaction

Represents a REST transaction containing all transaction details, lines, schedules, and exchange rates for excise tax calculations.

| Property | Type | Description |
|---|---|---|
| `TransactionSchedule` | Avalara.Excise.Determination.Engine.RestTransactionSchedule | Party, account, and address details at the transaction level used for excise tax schedule determination. |
| `TransactionLines` | array | Product or charge lines that make up this transaction. |
| `TransactionExchangeRates` | array | Foreign-exchange rates used to convert amounts across currencies on this transaction. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `InvoiceDate` | string | The date of the invoice. |
| `InvoiceNumber` | string | The invoice number. |
| `FuelUseCode` | string | The code classifying fuel end use for excise tax purposes. |
| `TitleTransferCode` | string | The code indicating the point of title transfer. |
| `TransactionType` | string | The transaction category (for example sale, purchase, or transfer). |
| `TransportationModeCode` | string | The mode of transportation for the movement (for example truck, rail, or pipeline). |
| `Seller` | string | The seller identifier on the transaction. |
| `Buyer` | string | The buyer identifier on the transaction. |
| `PreviousSeller` | string | The upstream seller in the supply chain, when applicable. |
| `NextBuyer` | string | The subsequent buyer in the supply chain, when applicable. |
| `Middleman` | string | The middleman or intermediary in the transaction chain. |
| `CustomsStatus` | string | Customs status for cross-border excise treatment. |
| `FormAPresentedInd` | string | Whether Form A was presented for duty-related exemption. |
| `SimplifiedProcedureInd` | string | Whether a simplified customs procedure applies. |
| `Incoterms` | string | Incoterms (international commercial terms) for the shipment or sale. |
| `PerspectiveBusinessType` | string | The reporting party's business type used to interpret the transaction for tax. |
| `ChainLeg` | string | Identifier for this leg in a multi-hop supply chain. |
| `OrderType` | string | The order or document type for this transaction. |
| `TotalDyedUnits` | number | Total quantity of dyed fuel units across the transaction. |
| `TotalReportingTaxes` | number | Aggregate tax in the reporting currency for compliance or ledger reporting. |
| `ReportingCurrency` | string | The ISO currency code for reporting amounts. |
| `ReportingUnitOfMeasure` | string | Unit of measure used for reporting quantities or bases on this transaction. |
| `UserData` | string | Opaque client-defined payload carried with the transaction. |
| `UserTranId` | string | Client-supplied identifier correlating this transaction in the caller's system. |
| `SourceSystem` | string | The originating system or application for this transaction. |
| `CustomString1` | string | Extension string field 1 for transaction-level attributes. |
| `CustomString2` | string | Extension string field 2 for transaction-level attributes. |
| `CustomString3` | string | Extension string field 3 for transaction-level attributes. |
| `CustomNumeric1` | number | Extension numeric field 1 for transaction-level attributes. |
| `CustomNumeric2` | number | Extension numeric field 2 for transaction-level attributes. |
| `CustomNumeric3` | number | Extension numeric field 3 for transaction-level attributes. |
| `DebugInd` | string | Requests diagnostic detail in the calculation response when supported. |
| `CalculationMethod` | string | The tax determination or calculation method to apply. |
| `CommitStatus` | string | Posting or commit lifecycle state of the transaction. |
| `AvaTaxTransactionType` | string | Transaction type code used when integrating with AvaTax. |
| `Discount` | number | Discount amount applied at the transaction level. |
| `EntityUseCode` | string | Entity use code affecting exemption or tax treatment. |
| `CustomString4` | string | Extension string field 4 for transaction-level attributes. |
| `CustomString5` | string | Extension string field 5 for transaction-level attributes. |
| `CustomString6` | string | Extension string field 6 for transaction-level attributes. |
| `CustomString7` | string | Extension string field 7 for transaction-level attributes. |
| `CustomString8` | string | Extension string field 8 for transaction-level attributes. |
| `CustomString9` | string | Extension string field 9 for transaction-level attributes. |
| `CustomString10` | string | Extension string field 10 for transaction-level attributes. |
| `CustomNumeric4` | number | Extension numeric field 4 for transaction-level attributes. |
| `CustomNumeric5` | number | Extension numeric field 5 for transaction-level attributes. |
| `CustomNumeric6` | number | Extension numeric field 6 for transaction-level attributes. |
| `CustomNumeric7` | number | Extension numeric field 7 for transaction-level attributes. |
| `CustomNumeric8` | number | Extension numeric field 8 for transaction-level attributes. |
| `CustomNumeric9` | number | Extension numeric field 9 for transaction-level attributes. |
| `CustomNumeric10` | number | Extension numeric field 10 for transaction-level attributes. |
| `ExemptionCode` | string | Code indicating a tax exemption reason or program. |
| `SellerImporterOfRecordInd` | string | Whether the seller is the importer of record for customs or excise purposes. |

### Avalara.Excise.Determination.Engine.RestTransactionSchedule

Party, account, and address details at the transaction schedule level used for excise tax determination.

| Property | Type | Description |
|---|---|---|
| `BuyerAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the buyer's account location. |
| `BuyerAccountCustomId` | string | Custom identifier for the buyer's account. |
| `BuyerAccountJurisdiction` | string | The jurisdiction or state code for the buyer's account. |
| `BuyerAddress1` | string | The first line of the buyer's address. |
| `BuyerAddress2` | string | The second line of the buyer's address. |
| `BuyerAlternateJurisdiction` | string | Alternate tax jurisdiction for the buyer. |
| `BuyerBusinessSubType` | string | Business subtype classification for the buyer. |
| `BuyerCity` | string | The city for the buyer's address. |
| `BuyerCountryCode` | string | The ISO 3166-1 alpha-3 country code for the buyer. |
| `BuyerCounty` | string | The county for the buyer's address. |
| `BuyerCountyCode` | string | The county code for the buyer. |
| `BuyerCustomId` | string | Custom identifier for the buyer party. |
| `BuyerIdCode` | string | Tax or regulatory identifier value for the buyer. |
| `BuyerIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the buyer's identifier. |
| `BuyerIdType` | string | Type of tax or regulatory identifier for the buyer. |
| `BuyerJurisdiction` | string | The jurisdiction or state code for the buyer. |
| `BuyerLegalName` | string | Legal name of the buyer. |
| `BuyerLicenseNumber` | string | License or permit number for the buyer. |
| `BuyerLicensePercentage` | number | Licensed capacity or ownership percentage for the buyer. |
| `BuyerNameControl` | string | Name control or matching token for the buyer. |
| `BuyerPostalCode` | string | Postal or ZIP code for the buyer's address. |
| `BuyerTradeName` | string | Doing-business-as or trade name for the buyer. |
| `CarrierAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the carrier's account location. |
| `CarrierAccountCustomId` | string | Custom identifier for the carrier's account. |
| `CarrierAccountJurisdiction` | string | The jurisdiction or state code for the carrier's account. |
| `CarrierAddress1` | string | The first line of the carrier's address. |
| `CarrierAddress2` | string | The second line of the carrier's address. |
| `CarrierAlternateJurisdiction` | string | Alternate tax jurisdiction for the carrier. |
| `CarrierBusinessSubType` | string | Business subtype classification for the carrier. |
| `CarrierCity` | string | The city for the carrier's address. |
| `CarrierCountryCode` | string | The ISO 3166-1 alpha-3 country code for the carrier. |
| `CarrierCounty` | string | The county for the carrier's address. |
| `CarrierCountyCode` | string | The county code for the carrier. |
| `CarrierCustomId` | string | Custom identifier for the carrier party. |
| `CarrierIdCode` | string | Tax or regulatory identifier value for the carrier. |
| `CarrierIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the carrier's identifier. |
| `CarrierIdType` | string | Type of tax or regulatory identifier for the carrier. |
| `CarrierJurisdiction` | string | The jurisdiction or state code for the carrier. |
| `CarrierLegalName` | string | Legal name of the carrier. |
| `CarrierLicenseNumber` | string | License or permit number for the carrier. |
| `CarrierLicensePercentage` | number | Licensed capacity or ownership percentage for the carrier. |
| `CarrierNameControl` | string | Name control or matching token for the carrier. |
| `CarrierPostalCode` | string | Postal or ZIP code for the carrier's address. |
| `CarrierTradeName` | string | Doing-business-as or trade name for the carrier. |
| `ConsignorAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the consignor's account location. |
| `ConsignorAccountCustomId` | string | Custom identifier for the consignor's account. |
| `ConsignorAccountJurisdiction` | string | The jurisdiction or state code for the consignor's account. |
| `ConsignorAddress1` | string | The first line of the consignor's address. |
| `ConsignorAddress2` | string | The second line of the consignor's address. |
| `ConsignorAlternateJurisdiction` | string | Alternate tax jurisdiction for the consignor. |
| `ConsignorBusinessSubType` | string | Business subtype classification for the consignor. |
| `ConsignorCity` | string | The city for the consignor's address. |
| `ConsignorCountryCode` | string | The ISO 3166-1 alpha-3 country code for the consignor. |
| `ConsignorCounty` | string | The county for the consignor's address. |
| `ConsignorCountyCode` | string | The county code for the consignor. |
| `ConsignorCustomId` | string | Custom identifier for the consignor party. |
| `ConsignorIdCode` | string | Tax or regulatory identifier value for the consignor. |
| `ConsignorIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the consignor's identifier. |
| `ConsignorIdType` | string | Type of tax or regulatory identifier for the consignor. |
| `ConsignorJurisdiction` | string | The jurisdiction or state code for the consignor. |
| `ConsignorLegalName` | string | Legal name of the consignor. |
| `ConsignorLicenseNumber` | string | License or permit number for the consignor. |
| `ConsignorLicensePercentage` | number | Licensed capacity or ownership percentage for the consignor. |
| `ConsignorNameControl` | string | Name control or matching token for the consignor. |
| `ConsignorPostalCode` | string | Postal or ZIP code for the consignor's address. |
| `ConsignorTradeName` | string | Doing-business-as or trade name for the consignor. |
| `ExchangePositionAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the exchange position holder's account location. |
| `ExchangePositionAccountCustomId` | string | Custom identifier for the exchange position holder's account. |
| `ExchangePositionAccountJurisdiction` | string | The jurisdiction or state code for the exchange position holder's account. |
| `ExchangePositionAddress1` | string | The first line of the exchange position holder's address. |
| `ExchangePositionAddress2` | string | The second line of the exchange position holder's address. |
| `ExchangePositionAlternateJurisdiction` | string | Alternate tax jurisdiction for the exchange position holder. |
| `ExchangePositionBusinessSubType` | string | Business subtype classification for the exchange position holder. |
| `ExchangePositionCity` | string | The city for the exchange position holder's address. |
| `ExchangePositionCountryCode` | string | The ISO 3166-1 alpha-3 country code for the exchange position holder. |
| `ExchangePositionCounty` | string | The county for the exchange position holder's address. |
| `ExchangePositionCountyCode` | string | The county code for the exchange position holder. |
| `ExchangePositionCustomId` | string | Custom identifier for the exchange position holder. |
| `ExchangePositionIdCode` | string | Tax or regulatory identifier value for the exchange position holder. |
| `ExchangePositionIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the exchange position holder's identifier. |
| `ExchangePositionIdType` | string | Type of tax or regulatory identifier for the exchange position holder. |
| `ExchangePositionJurisdiction` | string | The jurisdiction or state code for the exchange position holder. |
| `ExchangePositionLegalName` | string | Legal name of the exchange position holder. |
| `ExchangePositionLicenseNumber` | string | License or permit number for the exchange position holder. |
| `ExchangePositionLicensePercentage` | number | Licensed capacity or ownership percentage for the exchange position holder. |
| `ExchangePositionNameControl` | string | Name control or matching token for the exchange position holder. |
| `ExchangePositionPostalCode` | string | Postal or ZIP code for the exchange position holder's address. |
| `ExchangePositionTradeName` | string | Doing-business-as or trade name for the exchange position holder. |
| `ImporterAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the importer's account location. |
| `ImporterAccountCustomId` | string | Custom identifier for the importer's account. |
| `ImporterAccountJurisdiction` | string | The jurisdiction or state code for the importer's account. |
| `ImporterAddress1` | string | The first line of the importer's address. |
| `ImporterAddress2` | string | The second line of the importer's address. |
| `ImporterAlternateJurisdiction` | string | Alternate tax jurisdiction for the importer. |
| `ImporterBusinessSubType` | string | Business subtype classification for the importer. |
| `ImporterCity` | string | The city for the importer's address. |
| `ImporterCountryCode` | string | The ISO 3166-1 alpha-3 country code for the importer. |
| `ImporterCounty` | string | The county for the importer's address. |
| `ImporterCountyCode` | string | The county code for the importer. |
| `ImporterCustomId` | string | Custom identifier for the importer party. |
| `ImporterIdCode` | string | Tax or regulatory identifier value for the importer. |
| `ImporterIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the importer's identifier. |
| `ImporterIdType` | string | Type of tax or regulatory identifier for the importer. |
| `ImporterJurisdiction` | string | The jurisdiction or state code for the importer. |
| `ImporterLegalName` | string | Legal name of the importer. |
| `ImporterLicenseNumber` | string | License or permit number for the importer. |
| `ImporterLicensePercentage` | number | Licensed capacity or ownership percentage for the importer. |
| `ImporterNameControl` | string | Name control or matching token for the importer. |
| `ImporterPostalCode` | string | Postal or ZIP code for the importer's address. |
| `ImporterTradeName` | string | Doing-business-as or trade name for the importer. |
| `MiddlemanAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the middleman's account location. |
| `MiddlemanAccountCustomId` | string | Custom identifier for the middleman's account. |
| `MiddlemanAccountJurisdiction` | string | The jurisdiction or state code for the middleman's account. |
| `MiddlemanAddress1` | string | The first line of the middleman's address. |
| `MiddlemanAddress2` | string | The second line of the middleman's address. |
| `MiddlemanAlternateJurisdiction` | string | Alternate tax jurisdiction for the middleman. |
| `MiddlemanBusinessSubType` | string | Business subtype classification for the middleman. |
| `MiddlemanCity` | string | The city for the middleman's address. |
| `MiddlemanCountryCode` | string | The ISO 3166-1 alpha-3 country code for the middleman. |
| `MiddlemanCounty` | string | The county for the middleman's address. |
| `MiddlemanCountyCode` | string | The county code for the middleman. |
| `MiddlemanCustomId` | string | Custom identifier for the middleman party. |
| `MiddlemanIdCode` | string | Tax or regulatory identifier value for the middleman. |
| `MiddlemanIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the middleman's identifier. |
| `MiddlemanIdType` | string | Type of tax or regulatory identifier for the middleman. |
| `MiddlemanJurisdiction` | string | The jurisdiction or state code for the middleman. |
| `MiddlemanLegalName` | string | Legal name of the middleman. |
| `MiddlemanLicenseNumber` | string | License or permit number for the middleman. |
| `MiddlemanLicensePercentage` | number | Licensed capacity or ownership percentage for the middleman. |
| `MiddlemanNameControl` | string | Name control or matching token for the middleman. |
| `MiddlemanPostalCode` | string | Postal or ZIP code for the middleman's address. |
| `MiddlemanTradeName` | string | Doing-business-as or trade name for the middleman. |
| `PositionHolderAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the position holder's account location. |
| `PositionHolderAccountCustomId` | string | Custom identifier for the position holder's account. |
| `PositionHolderAccountJurisdiction` | string | The jurisdiction or state code for the position holder's account. |
| `PositionHolderAddress1` | string | The first line of the position holder's address. |
| `PositionHolderAddress2` | string | The second line of the position holder's address. |
| `PositionHolderAlternateJurisdiction` | string | Alternate tax jurisdiction for the position holder. |
| `PositionHolderBusinessSubType` | string | Business subtype classification for the position holder. |
| `PositionHolderCity` | string | The city for the position holder's address. |
| `PositionHolderCountryCode` | string | The ISO 3166-1 alpha-3 country code for the position holder. |
| `PositionHolderCounty` | string | The county for the position holder's address. |
| `PositionHolderCountyCode` | string | The county code for the position holder. |
| `PositionHolderCustomId` | string | Custom identifier for the position holder. |
| `PositionHolderIdCode` | string | Tax or regulatory identifier value for the position holder. |
| `PositionHolderIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the position holder's identifier. |
| `PositionHolderIdType` | string | Type of tax or regulatory identifier for the position holder. |
| `PositionHolderJurisdiction` | string | The jurisdiction or state code for the position holder. |
| `PositionHolderLegalName` | string | Legal name of the position holder. |
| `PositionHolderLicenseNumber` | string | License or permit number for the position holder. |
| `PositionHolderLicensePercentage` | number | Licensed capacity or ownership percentage for the position holder. |
| `PositionHolderNameControl` | string | Name control or matching token for the position holder. |
| `PositionHolderPostalCode` | string | Postal or ZIP code for the position holder's address. |
| `PositionHolderTradeName` | string | Doing-business-as or trade name for the position holder. |
| `SellerAccountCountryCode` | string | The ISO 3166-1 alpha-3 country code for the seller's account location. |
| `SellerAccountCustomId` | string | Custom identifier for the seller's account. |
| `SellerAccountJurisdiction` | string | The jurisdiction or state code for the seller's account. |
| `SellerAddress1` | string | The first line of the seller's address. |
| `SellerAddress2` | string | The second line of the seller's address. |
| `SellerAlternateJurisdiction` | string | Alternate tax jurisdiction for the seller. |
| `SellerBusinessSubType` | string | Business subtype classification for the seller. |
| `SellerCity` | string | The city for the seller's address. |
| `SellerCountryCode` | string | The ISO 3166-1 alpha-3 country code for the seller. |
| `SellerCounty` | string | The county for the seller's address. |
| `SellerCountyCode` | string | The county code for the seller. |
| `SellerCustomId` | string | Custom identifier for the seller party. |
| `SellerIdCode` | string | Tax or regulatory identifier value for the seller. |
| `SellerIdCodeCountry` | string | The ISO 3166-1 alpha-3 country code associated with the seller's identifier. |
| `SellerIdType` | string | Type of tax or regulatory identifier for the seller. |
| `SellerJurisdiction` | string | The jurisdiction or state code for the seller. |
| `SellerLegalName` | string | Legal name of the seller. |
| `SellerLicenseNumber` | string | License or permit number for the seller. |
| `SellerLicensePercentage` | number | Licensed capacity or ownership percentage for the seller. |
| `SellerNameControl` | string | Name control or matching token for the seller. |
| `SellerPostalCode` | string | Postal or ZIP code for the seller's address. |
| `SellerTradeName` | string | Doing-business-as or trade name for the seller. |

### Avalara.Excise.Determination.Engine.RestTransactionLine

One product or charge line on an excise transaction, including locations, quantities, pricing, and schedule context for tax determination.

| Property | Type | Description |
|---|---|---|
| `TransactionLineSchedule` | Avalara.Excise.Determination.Engine.RestTransactionLineSchedule | Schedule-level attributes for this line used in excise tax determination (rates, bases, and jurisdiction-specific fields). |
| `TransactionLineMeasures` | array | Supplemental quantity measures for this line (for example alternate UOMs or gauge readings). |
| `OriginSpecialJurisdictions` | array | Special tax jurisdictions that apply at the origin of the movement. |
| `DestinationSpecialJurisdictions` | array | Special tax jurisdictions that apply at the destination of the movement. |
| `SaleSpecialJurisdictions` | array | Special tax jurisdictions that apply at the sale location. |
| `CounterSpecialJurisdictions` | array | Special tax jurisdictions that apply at the counterparty location. |
| `OrderOriginSpecialJurisdictions` | array | Special tax jurisdictions that apply at the point of order origin. |
| `OrderAcceptanceSpecialJurisdictions` | array | Special tax jurisdictions that apply at the point of order acceptance. |
| `GpsrSpecialJurisdictions` | array | Special tax jurisdictions for the goods place or service rendered location. |
| `BillToSpecialJurisdictions` | array | Special tax jurisdictions that apply at the bill-to location. |
| `InvoiceLine` | integer | The line number on the invoice or source document. |
| `MovementStartDate` | string | The start date of the movement or activity for this line. |
| `MovementEndDate` | string | The end date of the movement or activity for this line. |
| `ProductCode` | string | The product code identifier. |
| `BlendToProductCode` | string | The target product code when this line represents a blend into another product. |
| `UnitPrice` | number | Price per unit in the line currency before extensions. |
| `AlternateUnitPrice` | number | Alternate price per unit used when a secondary pricing basis applies. |
| `NetUnits` | number | Net quantity after deductions, in the line unit of measure. |
| `GrossUnits` | number | Gross quantity before deductions, in the line unit of measure. |
| `BilledUnits` | number | Quantity billed or invoiced, in the line unit of measure. |
| `LineAmount` | number | Extended line amount in the line currency. |
| `AlternateLineAmount` | number | Extended line amount on an alternate pricing or currency basis. |
| `BillOfLadingNumber` | string | The bill of lading or transport document number. |
| `BillOfLadingDate` | string | The date on the bill of lading or transport document. |
| `OriginCountryCode` | string | The ISO 3166-1 alpha-3 country code for the origin. |
| `OriginJurisdiction` | string | The jurisdiction or state code for the origin. |
| `OriginCounty` | string | The origin county name or description. |
| `OriginCity` | string | The origin city. |
| `OriginPostalCode` | string | The origin postal or ZIP code. |
| `OriginType` | string | The type of origin location (for example terminal, rack, or retail). |
| `Origin` | string | The origin location or facility identifier. |
| `OriginOutCityLimitInd` | string | Whether the origin is outside municipal limits for tax sourcing. |
| `OriginSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies at the origin. |
| `OriginExciseWarehouse` | string | Excise warehouse or bonded location identifier at the origin. |
| `OriginAddress1` | string | The first line of the origin street address. |
| `OriginAddress2` | string | The second line of the origin street address. |
| `OriginAirportCode` | string | The IATA or FAA airport code for the origin when movement is by air. |
| `DestinationCountryCode` | string | The ISO 3166-1 alpha-3 country code for the destination. |
| `DestinationJurisdiction` | string | The jurisdiction or state code for the destination. |
| `DestinationCounty` | string | The destination county name or description. |
| `DestinationCity` | string | The destination city. |
| `DestinationPostalCode` | string | The destination postal or ZIP code. |
| `DestinationType` | string | The type of destination location (for example terminal, rack, or retail). |
| `Destination` | string | The destination location or facility identifier. |
| `DestinationOutCityLimitInd` | string | Whether the destination is outside municipal limits for tax sourcing. |
| `DestinationSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies at the destination. |
| `DestinationExciseWarehouse` | string | Excise warehouse or bonded location identifier at the destination. |
| `DestinationAddress1` | string | The first line of the destination street address. |
| `DestinationAddress2` | string | The second line of the destination street address. |
| `DestinationAirportCode` | string | The IATA or FAA airport code for the destination when movement is by air. |
| `SaleCountryCode` | string | The ISO 3166-1 alpha-3 country code for the sale location. |
| `SaleJurisdiction` | string | The jurisdiction or state code for the sale location. |
| `SaleCounty` | string | The county for the sale location. |
| `SaleCity` | string | The city for the sale location. |
| `SalePostalCode` | string | The postal or ZIP code for the sale location. |
| `SaleType` | string | The type of sale location (for example retail, wholesale, or delivery). |
| `SaleLocation` | string | The sale location or outlet identifier. |
| `SaleOutCityLimitInd` | string | Whether the sale location is outside municipal limits for tax sourcing. |
| `SaleSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies at the sale location. |
| `SaleExciseWarehouse` | string | Excise warehouse or bonded location identifier at the sale location. |
| `SaleAddress1` | string | The first line of the sale location street address. |
| `SaleAddress2` | string | The second line of the sale location street address. |
| `SaleAirportCode` | string | The IATA or FAA airport code for the sale location when relevant. |
| `CounterCountryCode` | string | The ISO 3166-1 alpha-3 country code for the counterparty. |
| `CounterJurisdiction` | string | The jurisdiction or state code for the counterparty. |
| `CounterCounty` | string | The county for the counterparty address. |
| `CounterCity` | string | The city for the counterparty address. |
| `CounterPostalCode` | string | The postal or ZIP code for the counterparty address. |
| `CounterType` | string | The type of counterparty location for tax sourcing. |
| `CounterParty` | string | The counterparty location or entity identifier. |
| `CounterOutCityLimitInd` | string | Whether the counterparty is outside municipal limits for tax sourcing. |
| `CounterSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies to the counterparty. |
| `CounterExciseWarehouse` | string | Excise warehouse or bonded location identifier for the counterparty. |
| `CounterFiscalRepInd` | string | Whether the counterparty acts through a fiscal representative for indirect tax. |
| `CounterAddress1` | string | The first line of the counterparty street address. |
| `CounterAddress2` | string | The second line of the counterparty street address. |
| `CounterAirportCode` | string | The IATA or FAA airport code for the counterparty when relevant. |
| `PtOrderOrigin` | string | The point-of-order-origin location identifier. |
| `PtOrderOriginCountryCode` | string | The ISO 3166-1 alpha-3 country code for the point of order origin. |
| `PtOrderOriginJurisdiction` | string | The jurisdiction or state code for the point of order origin. |
| `PtOrderOriginCounty` | string | The county for the point of order origin. |
| `PtOrderOriginCity` | string | The city for the point of order origin. |
| `PtOrderOriginPostalCode` | string | The postal or ZIP code for the point of order origin. |
| `PtOrderOriginType` | string | The location type for the point of order origin. |
| `PtOrderOriginOutCityLimitInd` | string | Whether the point of order origin is outside municipal limits for tax sourcing. |
| `PtOrderOriginCustomId` | string | Client-defined identifier for the point of order origin. |
| `PtOrderOriginSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies at the point of order origin. |
| `PtOrderOriginExciseWarehouse` | string | Excise warehouse or bonded location identifier at the point of order origin. |
| `PtOrderOriginAddress1` | string | The first line of the point-of-order-origin street address. |
| `PtOrderOriginAddress2` | string | The second line of the point-of-order-origin street address. |
| `PtOrderOriginAirportCode` | string | The IATA or FAA airport code for the point of order origin when relevant. |
| `PtOrderAccept` | string | The point-of-order-acceptance location identifier. |
| `PtOrderAcceptCountryCode` | string | The ISO 3166-1 alpha-3 country code for the point of order acceptance. |
| `PtOrderAcceptJurisdiction` | string | The jurisdiction or state code for the point of order acceptance. |
| `PtOrderAcceptCounty` | string | The county for the point of order acceptance. |
| `PtOrderAcceptCity` | string | The city for the point of order acceptance. |
| `PtOrderAcceptPostalCode` | string | The postal or ZIP code for the point of order acceptance. |
| `PtOrderAcceptType` | string | The location type for the point of order acceptance. |
| `PtOrderAcceptOutCityLimitInd` | string | Whether the point of order acceptance is outside municipal limits for tax sourcing. |
| `PtOrderAcceptCustomId` | string | Client-defined identifier for the point of order acceptance. |
| `PtOrderAcceptSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies at the point of order acceptance. |
| `PtOrderAcceptExciseWarehouse` | string | Excise warehouse or bonded location identifier at the point of order acceptance. |
| `PtOrderAcceptAddress1` | string | The first line of the point-of-order-acceptance street address. |
| `PtOrderAcceptAddress2` | string | The second line of the point-of-order-acceptance street address. |
| `PtOrderAcceptAirportCode` | string | The IATA or FAA airport code for the point of order acceptance when relevant. |
| `Gpsr` | string | The location identifier for where goods are situated or the service is rendered. |
| `GpsrCountryCode` | string | The ISO 3166-1 alpha-3 country code for the goods place or service rendered. |
| `GpsrJurisdiction` | string | The jurisdiction or state code for the goods place or service rendered. |
| `GpsrCounty` | string | The county for the goods place or service rendered. |
| `GpsrCity` | string | The city for the goods place or service rendered. |
| `GpsrPostalCode` | string | The postal or ZIP code for the goods place or service rendered. |
| `GpsrType` | string | The location type for the goods place or service rendered. |
| `GpsrOutCityLimitInd` | string | Whether the goods place or service rendered is outside municipal limits for tax sourcing. |
| `GpsrCustomId` | string | Client-defined identifier for the goods place or service rendered. |
| `GpsrSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies to the goods place or service rendered. |
| `GpsrExciseWarehouse` | string | Excise warehouse or bonded location identifier for the goods place or service rendered. |
| `GpsrAddress1` | string | The first line of the street address for the goods place or service rendered. |
| `GpsrAddress2` | string | The second line of the street address for the goods place or service rendered. |
| `GpsrAirportCode` | string | The IATA or FAA airport code for the goods place or service rendered when relevant. |
| `BillTo` | string | The bill-to location identifier. |
| `BillToCountryCode` | string | The ISO 3166-1 alpha-3 country code for the bill-to address. |
| `BillToJurisdiction` | string | The jurisdiction or state code for the bill-to address. |
| `BillToCounty` | string | The county for the bill-to address. |
| `BillToCity` | string | The city for the bill-to address. |
| `BillToPostalCode` | string | The postal or ZIP code for the bill-to address. |
| `BillToType` | string | The bill-to location type for tax sourcing. |
| `BillToOutCityLimitInd` | string | Whether the bill-to location is outside municipal limits for tax sourcing. |
| `BillToCustomId` | string | Client-defined identifier for the bill-to party or location. |
| `BillToSpecialJurisdictionInd` | string | Whether a special tax jurisdiction applies at the bill-to location. |
| `BillToExciseWarehouse` | string | Excise warehouse or bonded location identifier for the bill-to address. |
| `BillToAddress1` | string | The first line of the bill-to street address. |
| `BillToAddress2` | string | The second line of the bill-to street address. |
| `BillToAirportCode` | string | The IATA or FAA airport code for the bill-to location when relevant. |
| `UserData` | string | Opaque client-defined data carried with this line. |
| `AlternativeFuelContent` | number | Share of alternative fuel content for the line product, when applicable. |
| `BlendToAltFuelContent` | number | Alternative fuel content for the blend-to product, when applicable. |
| `BlendToInd` | string | Whether this line represents or participates in a product blend. |
| `Currency` | string | The ISO currency code for monetary amounts on this line. |
| `UnitOfMeasure` | string | The unit of measure for the billed, net, and gross quantities on this line. |
| `FreightUnitPrice` | number | Freight charge per unit in the line currency. |
| `FreightType` | string | Classification of freight or delivery charges for tax treatment. |
| `FreightLineAmount` | number | Total freight amount in the line currency. |
| `CustomString1` | string | Extension string field 1 for line-level attributes. |
| `CustomString2` | string | Extension string field 2 for line-level attributes. |
| `CustomString3` | string | Extension string field 3 for line-level attributes. |
| `CustomNumeric1` | number | Extension numeric field 1 for line-level attributes. |
| `CustomNumeric2` | number | Extension numeric field 2 for line-level attributes. |
| `CustomNumeric3` | number | Extension numeric field 3 for line-level attributes. |
| `NthTimeSale` | number | Ordinal indicating which sale in a series this line represents (for recurring or tiered rules). |
| `TaxIncluded` | boolean | Whether excise or sales tax is included in the stated unit or line price. |
| `UnitQuantity` | number | Count of sellable units (for example packs or items) distinct from volume or weight. |
| `UnitQuantityUnitOfMeasure` | string | The unit of measure for the unit quantity count. |
| `UnitVolume` | number | Volume per single unit of product (for example per bottle or container). |
| `UnitVolumeUnitOfMeasure` | string | The unit of measure for the unit volume. |
| `UnitWeight` | number | Weight per single unit of product. |
| `UnitWeightUnitOfMeasure` | string | The unit of measure for the unit weight. |
| `UnitLength` | number | Length per single unit of product when dimension-based rules apply. |
| `UnitLengthUnitOfMeasure` | string | The unit of measure for the unit length. |
| `Discounted` | boolean | Whether the line is subject to a discount for tax base purposes. |
| `EntityUseCode` | string | Entity use code affecting exemption or tax treatment for this line. |
| `CustomString4` | string | Extension string field 4 for line-level attributes. |
| `CustomString5` | string | Extension string field 5 for line-level attributes. |
| `CustomString6` | string | Extension string field 6 for line-level attributes. |
| `CustomString7` | string | Extension string field 7 for line-level attributes. |
| `CustomString8` | string | Extension string field 8 for line-level attributes. |
| `CustomString9` | string | Extension string field 9 for line-level attributes. |
| `CustomString10` | string | Extension string field 10 for line-level attributes. |
| `CustomNumeric4` | number | Extension numeric field 4 for line-level attributes. |
| `CustomNumeric5` | number | Extension numeric field 5 for line-level attributes. |
| `CustomNumeric6` | number | Extension numeric field 6 for line-level attributes. |
| `CustomNumeric7` | number | Extension numeric field 7 for line-level attributes. |
| `CustomNumeric8` | number | Extension numeric field 8 for line-level attributes. |
| `CustomNumeric9` | number | Extension numeric field 9 for line-level attributes. |
| `CustomNumeric10` | number | Extension numeric field 10 for line-level attributes. |
| `ExemptionCode` | string | Code indicating a tax exemption reason or program for this line. |
| `HsCode` | string | Harmonized System (HS) tariff code for the product on this line. |

### Avalara.Excise.Determination.Engine.RestTransactionExchangeRate

Represents currency exchange rate information for REST transactions, including conversion factors and effective dates.

| Property | Type | Description |
|---|---|---|
| `FromCurrency` | string | The ISO currency code of the amount being converted from. |
| `ToCurrency` | string | The ISO currency code of the amount being converted to. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ConversionFactor` | number | Multiplier applied to convert from the source currency to the target currency. |

### Avalara.Excise.Determination.Engine.RestTransactionLineSchedule

Schedule-level facts for a transaction line used in excise tax determination (locations, products, bases, and jurisdiction-specific attributes).

| Property | Type | Description |
|---|---|---|
| `ActivityDate` | string | The date of the taxable activity for this schedule line. |
| `AllowanceCode` | string | Code identifying a credit, discount, or allowance affecting the tax base. |
| `BaseProduct` | string | The product code identifier for the base component of a blend. |
| `BaseProductUnits` | number | Quantity of the base product in the schedule unit of measure. |
| `BlendProduct1` | string | First blended component product code. |
| `BlendProduct1Units` | number | Quantity of the first blended component. |
| `BlendProduct2` | string | Second blended component product code. |
| `BlendProduct2Units` | number | Quantity of the second blended component. |
| `BlendProduct3` | string | Third blended component product code. |
| `BlendProduct3Units` | number | Quantity of the third blended component. |
| `DestinationAlternateFacilityNumber` | string | Alternate facility identifier at the destination for regulatory matching. |
| `DestinationAlternateJurisdiction` | string | Alternate tax jurisdiction code at the destination. |
| `DestinationCountyCode` | string | County code at the destination for schedule sourcing. |
| `DestinationDepNumber` | string | Department or district number assigned to the destination facility. |
| `DestinationDescription` | string | Human-readable description of the destination location or site. |
| `DestinationSiteCode` | string | Site or plant code for the destination. |
| `DestinationSpecialJurisdiction` | string | Special jurisdiction code applicable at the destination. |
| `DestinationStateAssignedCode` | string | State-assigned location or license code at the destination. |
| `DestinationTerminalCode` | string | Terminal or rack code at the destination. |
| `DiversionAddress1` | string | The first line of the diversion location street address. |
| `DiversionAddress2` | string | The second line of the diversion location street address. |
| `DiversionAirportCode` | string | Airport code associated with the diversion when movement is by air. |
| `DiversionAlternateFacilityNumber` | string | Alternate facility identifier for the diversion point. |
| `DiversionAlternateJurisdiction` | string | Alternate tax jurisdiction for the diversion. |
| `DiversionCity` | string | The city for the diversion location. |
| `DiversionCountryCode` | string | The ISO 3166-1 alpha-3 country code for the diversion location. |
| `DiversionCounty` | string | The county name for the diversion location. |
| `DiversionCountyCode` | string | The county code for the diversion location. |
| `DiversionCustomId` | string | Client-defined identifier for the diversion location. |
| `DiversionDepNumber` | string | Department or district number for the diversion facility. |
| `DiversionDescription` | string | Description of the diversion location or event. |
| `DiversionJurisdiction` | string | The jurisdiction or state code for the diversion location. |
| `DiversionType` | string | Classification of the diversion for tax purposes. |
| `DiversionOutsideCityLimitInd` | string | Whether the diversion is outside municipal limits for tax sourcing. |
| `DiversionPostalCode` | string | Postal or ZIP code for the diversion location. |
| `DiversionSiteCode` | string | Site or plant code for the diversion location. |
| `DiversionSpecialJurisdiction` | string | Special jurisdiction code for the diversion. |
| `DiversionStateAssignedCode` | string | State-assigned code for the diversion location. |
| `DiversionTerminalCode` | string | Terminal or rack code for the diversion location. |
| `DiversionNumber` | string | Reference number for the diversion event or permit. |
| `DocumentType` | string | Type of supporting document (for example manifest, return, or report). |
| `ExchangeInd` | string | Whether the transaction or line is an exchange for tax treatment. |
| `ExemptionType` | string | Category of exemption applied on this schedule line. |
| `FilingEntity` | string | Entity responsible for filing or remittance related to this line. |
| `ItemCode` | string | Jurisdiction-specific item or category code for the product. |
| `ItemCodeDescription` | string | Description text for the item code. |
| `ManufacturerCode` | string | Manufacturer code registered for excise or tobacco reporting. |
| `ManufacturerCountryCode` | string | The ISO 3166-1 alpha-3 country code for the manufacturer. |
| `ManufacturerCustomId` | string | Client-defined manufacturer identifier. |
| `ManufacturerId` | integer | Internal system identifier for the manufacturer master record. |
| `ManufacturerIdCode` | string | Tax or regulatory identifier value for the manufacturer. |
| `ManufacturerIdType` | string | Type of tax or regulatory identifier for the manufacturer. |
| `ManufacturerJurisdiction` | string | Default jurisdiction or state code associated with the manufacturer. |
| `ManufacturerJurisdictionCountrycode` | string | Country code for the manufacturer's jurisdiction-specific registration. |
| `ManufacturerJurisdictionJurisdiction` | string | State or province code for the manufacturer's jurisdiction-specific registration. |
| `ManufacturerJurisdictionLicenseNumber` | string | License number for the manufacturer in the specified jurisdiction. |
| `ManufacturerJurisdictionManufacturerCode` | string | Manufacturer code as assigned in the specified jurisdiction. |
| `ManufacturerJurisdictionMsaStatus` | string | Master settlement agreement or comparable compliance status in the jurisdiction. |
| `ManufacturerLegalName` | string | Legal name of the manufacturer. |
| `ManufacturerLicenseNumber` | string | Primary license or permit number for the manufacturer. |
| `ManufacturerMailingAddress1` | string | First line of the manufacturer's mailing address. |
| `ManufacturerMailingAddress2` | string | Second line of the manufacturer's mailing address. |
| `ManufacturerMailingCity` | string | City on the manufacturer's mailing address. |
| `ManufacturerMailingCountryCode` | string | Country code on the manufacturer's mailing address. |
| `ManufacturerMailingCounty` | string | County on the manufacturer's mailing address. |
| `ManufacturerMailingCountyCode` | string | County code on the manufacturer's mailing address. |
| `ManufacturerMailingJurisdiction` | string | Jurisdiction or state code on the manufacturer's mailing address. |
| `ManufacturerMailingPostalCode` | string | Postal or ZIP code on the manufacturer's mailing address. |
| `ManufacturerMsaStatus` | string | Master settlement agreement or comparable compliance status for the manufacturer. |
| `ManufacturerPhysicalAddress1` | string | First line of the manufacturer's physical address. |
| `ManufacturerPhysicalAddress2` | string | Second line of the manufacturer's physical address. |
| `ManufacturerPhysicalCity` | string | City on the manufacturer's physical address. |
| `ManufacturerPhysicalCountryCode` | string | Country code on the manufacturer's physical address. |
| `ManufacturerPhysicalCounty` | string | County on the manufacturer's physical address. |
| `ManufacturerPhysicalCountyCode` | string | County code on the manufacturer's physical address. |
| `ManufacturerPhysicalJurisdiction` | string | Jurisdiction or state code on the manufacturer's physical address. |
| `ManufacturerPhysicalPostalCode` | string | Postal or ZIP code on the manufacturer's physical address. |
| `ManufacturerTradeName` | string | Doing-business-as or trade name for the manufacturer. |
| `OriginAlternateFacilityNumber` | string | Alternate facility identifier at the origin for regulatory matching. |
| `OriginAlternateJurisdiction` | string | Alternate tax jurisdiction code at the origin. |
| `OriginCountyCode` | string | County code at the origin for schedule sourcing. |
| `OriginDepNumber` | string | Department or district number assigned to the origin facility. |
| `OriginDescription` | string | Human-readable description of the origin location or site. |
| `OriginSiteCode` | string | Site or plant code for the origin. |
| `OriginSpecialJurisdiction` | string | Special jurisdiction code applicable at the origin. |
| `OriginStateAssignedCode` | string | State-assigned location or license code at the origin. |
| `OriginTerminalCode` | string | Terminal or rack code at the origin. |
| `PaymentDate` | string | The date payment is due or was made for this schedule line. |
| `ProductTobaccoAttribute01` | string | Tobacco schedule attribute 1 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute02` | string | Tobacco schedule attribute 2 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute03` | string | Tobacco schedule attribute 3 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute04` | string | Tobacco schedule attribute 4 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute05` | string | Tobacco schedule attribute 5 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute06` | string | Tobacco schedule attribute 6 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute07` | string | Tobacco schedule attribute 7 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute08` | string | Tobacco schedule attribute 8 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute09` | string | Tobacco schedule attribute 9 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute10` | string | Tobacco schedule attribute 10 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute11` | string | Tobacco schedule attribute 11 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute12` | string | Tobacco schedule attribute 12 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute13` | string | Tobacco schedule attribute 13 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute14` | string | Tobacco schedule attribute 14 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttribute15` | string | Tobacco schedule attribute 15 name or key for jurisdiction-specific product matching. |
| `ProductTobaccoAttributeValue01` | string | Value paired with tobacco schedule attribute 1. |
| `ProductTobaccoAttributeValue02` | string | Value paired with tobacco schedule attribute 2. |
| `ProductTobaccoAttributeValue03` | string | Value paired with tobacco schedule attribute 3. |
| `ProductTobaccoAttributeValue04` | string | Value paired with tobacco schedule attribute 4. |
| `ProductTobaccoAttributeValue05` | string | Value paired with tobacco schedule attribute 5. |
| `ProductTobaccoAttributeValue06` | string | Value paired with tobacco schedule attribute 6. |
| `ProductTobaccoAttributeValue07` | string | Value paired with tobacco schedule attribute 7. |
| `ProductTobaccoAttributeValue08` | string | Value paired with tobacco schedule attribute 8. |
| `ProductTobaccoAttributeValue09` | string | Value paired with tobacco schedule attribute 9. |
| `ProductTobaccoAttributeValue10` | string | Value paired with tobacco schedule attribute 10. |
| `ProductTobaccoAttributeValue11` | string | Value paired with tobacco schedule attribute 11. |
| `ProductTobaccoAttributeValue12` | string | Value paired with tobacco schedule attribute 12. |
| `ProductTobaccoAttributeValue13` | string | Value paired with tobacco schedule attribute 13. |
| `ProductTobaccoAttributeValue14` | string | Value paired with tobacco schedule attribute 14. |
| `ProductTobaccoAttributeValue15` | string | Value paired with tobacco schedule attribute 15. |
| `ProductTobaccoBrandCode` | string | Brand code for the tobacco product on this schedule line. |
| `ProductTobaccoCountryCode` | string | The ISO 3166-1 alpha-3 country code for the tobacco product registration. |
| `ProductTobaccoCustomId` | string | Client-defined identifier for the tobacco product definition. |
| `ProductTobaccoDescription` | string | Description of the tobacco product for reporting or matching. |
| `ProductTobaccoId` | integer | Internal identifier for the tobacco product master record. |
| `ProductTobaccoJurisdiction` | string | The jurisdiction or state code for tobacco product registration. |
| `ProductTobaccoJurisdictionDescriptionCode` | string | Jurisdiction-specific description or classification code for the tobacco product. |
| `ProductTobaccoModifiedRiskNumber` | string | Modified-risk tobacco product authorization or filing number. |
| `ProductTobaccoModifiedRiskType` | string | Modified-risk product category or program type. |
| `ProductTobaccoName` | string | Marketing or trade name of the tobacco product. |
| `ProductTobaccoPackSize` | integer | Count of units per package for the tobacco product. |
| `ProductTobaccoProductCode` | string | The product code identifier for the tobacco SKU. |
| `ProductTobaccoSku` | string | Stock keeping unit identifier for the tobacco product. |
| `ProductTobaccoStyle` | string | Product style or form factor (for example cigarette, OTP, smokeless). |
| `ProductTobaccoUnitLength` | number | Unit length dimension for the tobacco product. |
| `ProductTobaccoUnitLengthOfMeasure` | string | The unit of measure for the unit length. |
| `ProductTobaccoUnitOfMeasure` | string | The unit of measure for tobacco quantities on this schedule line. |
| `ProductTobaccoUnitsPerPackage` | number | Number of sellable units per consumer package. |
| `ProductTobaccoUnitVolume` | number | Unit volume for the tobacco product (for example per stick or pack). |
| `ProductTobaccoUnitVolumeUnitOfMeasure` | string | The unit of measure for the unit volume. |
| `ProductTobaccoUnitWeight` | number | Unit weight for the tobacco product. |
| `ProductTobaccoUnitWeightUnitOfMeasure` | string | The unit of measure for the unit weight. |
| `ProductTobaccoUpc` | string | Universal product code for the tobacco item. |
| `PtOrderAcceptAlternateFacilityNumber` | string | Alternate facility identifier at the point of order acceptance for schedule sourcing. |
| `PtOrderAcceptAlternateJurisdiction` | string | Alternate tax jurisdiction at the point of order acceptance. |
| `PtOrderAcceptCountyCode` | string | County code at the point of order acceptance. |
| `PtOrderAcceptDepNumber` | string | Department or district number at the point of order acceptance. |
| `PtOrderAcceptDescription` | string | Description of the point-of-order-acceptance location. |
| `PtOrderAcceptSiteCode` | string | Site or plant code at the point of order acceptance. |
| `PtOrderAcceptSpecialJurisdiction` | string | Special jurisdiction code at the point of order acceptance. |
| `PtOrderAcceptStateAssignedCode` | string | State-assigned location code at the point of order acceptance. |
| `PtOrderAcceptTerminalCode` | string | Terminal or rack code at the point of order acceptance. |
| `PtOrderOriginAlternateFacilityNumber` | string | Alternate facility identifier at the point of order origin for schedule sourcing. |
| `PtOrderOriginAlternateJurisdiction` | string | Alternate tax jurisdiction at the point of order origin. |
| `PtOrderOriginCountyCode` | string | County code at the point of order origin. |
| `PtOrderOriginDepNumber` | string | Department or district number at the point of order origin. |
| `PtOrderOriginDescription` | string | Description of the point-of-order-origin location. |
| `PtOrderOriginSiteCode` | string | Site or plant code at the point of order origin. |
| `PtOrderOriginSpecialJurisdiction` | string | Special jurisdiction code at the point of order origin. |
| `PtOrderOriginStateAssignedCode` | string | State-assigned location code at the point of order origin. |
| `PtOrderOriginTerminalCode` | string | Terminal or rack code at the point of order origin. |
| `PurchaseDate` | string | The date of purchase for this schedule line. |
| `SalesAmount` | number | Gross sales amount associated with this schedule line. |
| `ScheduleCode` | string | Excise schedule code selecting rate and rule paths. |
| `ScheduleType` | string | Category of excise schedule (for example import, export, or refund). |
| `SequenceId` | string | Client sequence or correlation identifier within the schedule. |
| `StampAttribute` | string | Tax stamp variant or attribute for stamped products. |
| `SystemOfRecord` | string | Originating business system or ledger for this line. |
| `SystemOfRecordProductCode` | string | Product code as recorded in the system of record. |
| `TaxCollected` | number | Tax amount already collected or withheld for this line. |
| `TaxSessionCountryCode` | string | The ISO 3166-1 alpha-3 country code for the tax session or filing context. |
| `TaxSessionJurisdiction` | string | The jurisdiction or state code for the tax session. |
| `TaxSessionLocationId` | integer | Identifier of the filing location or outlet for the tax session. |
| `TaxSessionTaxpayerType` | string | Taxpayer classification for the session (for example distributor or retailer). |
| `TaxSessionTerminalCode` | string | Terminal or device code associated with the tax session. |
| `TobaccoJurisdictionsBrandCode` | string | Brand code used for tobacco jurisdiction matching. |
| `TobaccoJurisdictionsCountryCode` | string | Country code used for tobacco jurisdiction matching. |
| `TobaccoJurisdictionsJurisdiction` | string | Jurisdiction or state code used for tobacco product matching. |
| `TobaccoJurisdictionsJurisdictionDescriptionCode` | string | Jurisdiction-specific description code for tobacco matching. |
| `TobaccoJurisdictionsModifiedRiskNumber` | string | Modified-risk reference used in tobacco jurisdiction matching. |
| `TobaccoJurisdictionsModifiedRiskType` | string | Modified-risk type used in tobacco jurisdiction matching. |
| `TobaccoJurisdictionsProductCode` | string | The product code identifier used for tobacco jurisdiction matching. |
| `TobaccoJurisdictionsStyle` | string | Product style used for tobacco jurisdiction matching. |
| `Acres` | number | Acreage associated with agricultural or land-based excise reporting. |
| `ActionType` | string | Classification of the schedule action (for example production, import, or sale). |
| `AdjustedBalance` | number | Adjusted account balance used as a tax base component. |
| `AdjustedCredits` | number | Adjusted credit quantity or amount applied to the line. |
| `AdjustedMiles` | number | Adjusted vehicle miles for mileage-based fuel or highway taxes. |
| `AdjustedTax` | number | Adjusted tax amount for amended or corrected returns. |
| `AdjustedUnits` | number | Adjusted quantity in the schedule unit of measure. |
| `AdjustmentCode` | string | Code identifying the type of adjustment applied. |
| `AdjustmentExplanation` | string | Narrative explanation for an adjustment. |
| `AircraftType` | string | Aircraft classification for aviation fuel or use tax. |
| `AltDocumentNumber` | string | Alternate document or filing reference number. |
| `AviationType` | string | Aviation operation type affecting tax treatment. |
| `AzUstBuyerExemptNumber` | string | Arizona UST buyer exemption certificate number when applicable. |
| `Balance` | number | Running balance or inventory quantity relevant to the tax base. |
| `BeginningDate` | string | Start date of the measurement or reporting period. |
| `BeginningReading` | number | Opening meter, gauge, or tank reading for the period. |
| `BilledUnitsProduced` | number | Billed production quantity for manufacturing or refining schedules. |
| `BranchNumber` | string | Branch or retail outlet identifier. |
| `BuyerExemptNumber` | string | Buyer exemption or license number on file with the jurisdiction. |
| `ContactInfo1` | string | Primary contact detail for filing or audit support. |
| `ContactInfo2` | string | Secondary contact detail for filing or audit support. |
| `ContactInfo3` | string | Tertiary contact detail for filing or audit support. |
| `ContactInfo4` | string | Additional contact detail for filing or audit support. |
| `CorrectionType` | string | Type of return or line correction. |
| `CountryOfOrigin` | string | The ISO 3166-1 alpha-3 country code for the product's country of origin. |
| `CreditAmount` | number | Credit amount applied against tax or liability. |
| `Crop` | string | Crop type for agricultural fuel or excise programs. |
| `DeductionAmount` | number | Amount deducted from the tax base before rate application. |
| `DeductionTypeId` | string | Identifier for the deduction category or safe harbor. |
| `DestinationLicense` | string | License number for the destination facility or party. |
| `DiscountAmount` | number | Discount amount reducing the taxable price or base. |
| `DiversionDate` | string | The date of the diversion event for schedule matching. |
| `DriverLicenseNumber` | string | Driver license number for dyed fuel or highway use claims. |
| `EmblemNumber` | string | Highway use or trip permit emblem number. |
| `EndingDate` | string | End date of the measurement or reporting period. |
| `EndingReading` | number | Closing meter, gauge, or tank reading for the period. |
| `EntryValue` | number | Declared customs or entry value for import-related excise. |
| `EnvironmentalFeeInterest` | number | Interest component on environmental fee assessments. |
| `EnvironmentalFeePenalty` | number | Penalty component on environmental fee assessments. |
| `EquipmentCount` | number | Count of equipment units affecting the tax base. |
| `EquipmentType` | string | Equipment category for construction or off-road fuel programs. |
| `ErrorType` | string | Error or exception category for corrected filings. |
| `ExemptLocationType` | string | Type of location qualifying for a location-based exemption. |
| `Explanation` | string | Free-text explanation supporting the schedule line. |
| `FilingType` | string | Return or schedule filing category. |
| `FlightCount` | number | Number of flights for aviation fuel reporting. |
| `FlightDate` | string | Date of flight for aviation fuel reporting. |
| `FlightNumber` | string | Flight identifier for aviation fuel reporting. |
| `FuelEfficiency` | string | Fuel economy or efficiency factor used in tax calculations. |
| `FuelRate` | number | Consumption or burn rate used for fuel tax proration. |
| `FuelType` | string | Fuel grade or category (for example gasoline, diesel, CNG). |
| `FuelUseCodeDescOther` | string | Description when fuel use is categorized as other or custom. |
| `GasolineInterest` | number | Interest on gasoline tax assessments. |
| `GasolinePenalty` | number | Penalty on gasoline tax assessments. |
| `GrossReceiptsAmount` | number | Total gross receipts used as a tax base component. |
| `GrossUnitsProduced` | number | Gross production quantity before allowances or losses. |
| `HeatingType` | string | Heating system classification for energy excise programs. |
| `Horsepower` | string | Rated horsepower for equipment or vessel taxes. |
| `ImportComponentTaxRate` | number | Effective tax rate applied to an import component. |
| `ImportTaxRate` | number | Effective import excise rate for the line. |
| `ImportVerificationNumber` | string | Customs or excise import verification reference. |
| `InspectionFeeInterest` | number | Interest on inspection fee assessments. |
| `InspectionFeePenalty` | number | Penalty on inspection fee assessments. |
| `IvpNumber` | string | International fuel tax agreement (IFTA) or trip permit identifier. |
| `IvpPayment` | number | Payment amount associated with the IFTA or trip permit. |
| `Lessor` | string | Lessor name for leased vehicle or equipment reporting. |
| `LicenseTagNumber` | string | Vehicle license plate number. |
| `LicenseTagState` | string | Issuing jurisdiction for the license plate. |
| `Miles` | number | Total miles for mileage-based fuel or highway taxes. |
| `MilesOffRoad` | number | Off-road miles for fuel tax allocation. |
| `MilesOnRoad` | number | On-road miles for fuel tax allocation. |
| `MilesOther` | number | Miles categorized as other for proration rules. |
| `MilesOutOfState` | number | Miles traveled outside the filing jurisdiction. |
| `MsaStatus` | string | Master settlement agreement or comparable compliance status. |
| `NetUnitsProduced` | number | Net production quantity after deductions. |
| `NontaxableMiles` | number | Miles excluded from tax under exemption rules. |
| `NontaxableUnits` | number | Quantity excluded from tax under exemption rules. |
| `Odometer` | number | Odometer reading for vehicle-based reporting. |
| `OperationType` | string | Operation category (for example manufacturing, distribution, or retail). |
| `OriginTerminalOperatorName` | string | Operator of the origin terminal for custody transfer reporting. |
| `OtherUnits` | number | Additional quantity bucket not covered by standard taxable or nontaxable fields. |
| `PackSize` | integer | Units per consumer package for stamped or counted products. |
| `PrintSchedLicense` | string | License required for printing or ordering tax stamps or schedules. |
| `ProductCount` | number | Count of discrete product units for schedule apportionment. |
| `ProductProduced` | string | The product code identifier for goods produced on this schedule line. |
| `ProductVolume` | number | Product volume for density or volumetric tax bases. |
| `ProductWeight` | number | Product weight for mass-based excise calculations. |
| `PumpNumber` | string | Dispensing pump identifier at retail. |
| `PumpNumberNew` | string | Replacement pump identifier after equipment change. |
| `PurchasePrice` | number | Purchase price per unit for ad valorem or markup taxes. |
| `PurchaseType` | string | Purchase category (for example bulk, rack, or retail). |
| `RateTypeId` | string | Identifier selecting which rate table or tier applies. |
| `ReceiptType` | string | Receipt or transaction subtype for sourcing rules. |
| `RegistrationNumber` | string | Equipment or vehicle registration number. |
| `ReportLevel` | string | Aggregation level for reporting (for example company, depot, or device). |
| `ResidentialType` | string | Residential classification for energy or fuel use taxes. |
| `RetailPrice` | number | Retail selling price for ad valorem excise. |
| `RuleId` | string | Determination rule identifier applied to this schedule line. |
| `Schedule4bTotal` | number | Total for Schedule 4B or equivalent supplemental schedule. |
| `SignedStatementNumber` | string | Signed statement or certification number supporting the filing. |
| `SpecialFuelInterest` | number | Interest on special (non-gasoline) fuel tax assessments. |
| `SpecialFuelPenalty` | number | Penalty on special (non-gasoline) fuel tax assessments. |
| `StampType` | string | Tax stamp series or type for stamped products. |
| `StateAssignedLocationCode` | string | State-assigned location or outlet code for filing. |
| `StatusType` | string | Lifecycle or processing status of the schedule line. |
| `SubRuleId` | string | Sub-rule or variant identifier under the primary rule. |
| `TankCapacity` | number | Maximum storage capacity of the tank in the schedule unit of measure. |
| `TankNumber` | string | Storage tank identifier. |
| `TankReading` | number | Gauge or dip reading for the storage tank. |
| `TaxDollarsRecovered` | number | Tax dollars recovered or claimed back on this line. |
| `TaxFreeType` | string | Category describing tax-free treatment of the transaction. |
| `TaxPaidType` | string | Indicates how prior tax was paid (for example prepaid or deferred). |
| `TaxRate` | number | Effective tax rate applied to the line (when supplied or overridden). |
| `TaxTypeId` | string | Excise tax category identifier (for example motor fuel, alcohol, or tobacco). |
| `Taxable` | number | Amount or portion of the line that is subject to tax. |
| `TaxableMiles` | number | Miles included in the taxable mileage base. |
| `TaxableUnits` | number | Quantity included in the taxable unit base for this schedule. |
| `TaxationType` | string | Method of taxation (for example specific, ad valorem, or composite). |
| `TaxingJurisdiction` | string | Name or code of the jurisdiction imposing tax on this line. |
| `TransferType` | string | Type of inventory or title transfer for petroleum or bulk products. |
| `TribalCode` | string | Tribal government or nation code for native lands sourcing. |
| `TribalIdCode` | string | Tribal enrollment or business identifier. |
| `TribalName` | string | Official name of the tribal entity. |
| `TribalReservation` | string | Reservation or tribal territory designation. |
| `UnitsPerPackage` | number | Number of countable units per package for the schedule line. |
| `VehicleIdNumber` | string | Vehicle identification number (VIN). |
| `VehicleLeasedInd` | string | Whether the vehicle is leased rather than owned. |
| `VehicleMake` | string | Vehicle manufacturer name. |
| `VehicleModel` | string | Vehicle model name. |
| `VehicleModelYear` | string | Vehicle model year. |
| `VehicleOwnedInd` | string | Whether the vehicle is owned by the reporting taxpayer. |
| `VehicleType` | string | Vehicle classification (for example truck, bus, or automobile). |
| `VehicleUseType` | string | End use of the vehicle for fuel tax (for example commercial or personal). |
| `VehicleWeight` | number | Gross vehicle weight for highway or registration taxes. |
| `VesselName` | string | Name of the vessel for marine fuel reporting. |
| `VesselNumber` | string | Official number or identifier of the vessel. |
| `WholesalePrice` | number | Wholesale list or transfer price before retail markup. |
| `UnitOfMeasure` | string | The unit of measure for schedule quantities on this line. |
| `CustomDate01` | string | Extension date field 1 for schedule-level attributes. |
| `CustomDate02` | string | Extension date field 2 for schedule-level attributes. |
| `CustomDate03` | string | Extension date field 3 for schedule-level attributes. |
| `CustomDate04` | string | Extension date field 4 for schedule-level attributes. |
| `CustomDate05` | string | Extension date field 5 for schedule-level attributes. |
| `CustomDate06` | string | Extension date field 6 for schedule-level attributes. |
| `CustomDate07` | string | Extension date field 7 for schedule-level attributes. |
| `CustomDate08` | string | Extension date field 8 for schedule-level attributes. |
| `CustomDate09` | string | Extension date field 9 for schedule-level attributes. |
| `CustomDate10` | string | Extension date field 10 for schedule-level attributes. |
| `CustomNumeric01` | number | Extension numeric field 1 for schedule-level attributes. |
| `CustomNumeric02` | number | Extension numeric field 2 for schedule-level attributes. |
| `CustomNumeric03` | number | Extension numeric field 3 for schedule-level attributes. |
| `CustomNumeric04` | number | Extension numeric field 4 for schedule-level attributes. |
| `CustomNumeric05` | number | Extension numeric field 5 for schedule-level attributes. |
| `CustomNumeric06` | number | Extension numeric field 6 for schedule-level attributes. |
| `CustomNumeric07` | number | Extension numeric field 7 for schedule-level attributes. |
| `CustomNumeric08` | number | Extension numeric field 8 for schedule-level attributes. |
| `CustomNumeric09` | number | Extension numeric field 9 for schedule-level attributes. |
| `CustomNumeric10` | number | Extension numeric field 10 for schedule-level attributes. |
| `CustomNumeric11` | number | Extension numeric field 11 for schedule-level attributes. |
| `CustomNumeric12` | number | Extension numeric field 12 for schedule-level attributes. |
| `CustomNumeric13` | number | Extension numeric field 13 for schedule-level attributes. |
| `CustomNumeric14` | number | Extension numeric field 14 for schedule-level attributes. |
| `CustomNumeric15` | number | Extension numeric field 15 for schedule-level attributes. |
| `CustomNumeric16` | number | Extension numeric field 16 for schedule-level attributes. |
| `CustomNumeric17` | number | Extension numeric field 17 for schedule-level attributes. |
| `CustomNumeric18` | number | Extension numeric field 18 for schedule-level attributes. |
| `CustomNumeric19` | number | Extension numeric field 19 for schedule-level attributes. |
| `CustomNumeric20` | number | Extension numeric field 20 for schedule-level attributes. |
| `CustomNumeric21` | number | Extension numeric field 21 for schedule-level attributes. |
| `CustomNumeric22` | number | Extension numeric field 22 for schedule-level attributes. |
| `CustomNumeric23` | number | Extension numeric field 23 for schedule-level attributes. |
| `CustomNumeric24` | number | Extension numeric field 24 for schedule-level attributes. |
| `CustomNumeric25` | number | Extension numeric field 25 for schedule-level attributes. |
| `CustomNumeric26` | number | Extension numeric field 26 for schedule-level attributes. |
| `CustomNumeric27` | number | Extension numeric field 27 for schedule-level attributes. |
| `CustomNumeric28` | number | Extension numeric field 28 for schedule-level attributes. |
| `CustomNumeric29` | number | Extension numeric field 29 for schedule-level attributes. |
| `CustomNumeric30` | number | Extension numeric field 30 for schedule-level attributes. |
| `CustomString01` | string | Extension string field 1 for schedule-level attributes. |
| `CustomString02` | string | Extension string field 2 for schedule-level attributes. |
| `CustomString03` | string | Extension string field 3 for schedule-level attributes. |
| `CustomString04` | string | Extension string field 4 for schedule-level attributes. |
| `CustomString05` | string | Extension string field 5 for schedule-level attributes. |
| `CustomString06` | string | Extension string field 6 for schedule-level attributes. |
| `CustomString07` | string | Extension string field 7 for schedule-level attributes. |
| `CustomString08` | string | Extension string field 8 for schedule-level attributes. |
| `CustomString09` | string | Extension string field 9 for schedule-level attributes. |
| `CustomString10` | string | Extension string field 10 for schedule-level attributes. |
| `CustomString11` | string | Extension string field 11 for schedule-level attributes. |
| `CustomString12` | string | Extension string field 12 for schedule-level attributes. |
| `CustomString13` | string | Extension string field 13 for schedule-level attributes. |
| `CustomString14` | string | Extension string field 14 for schedule-level attributes. |
| `CustomString15` | string | Extension string field 15 for schedule-level attributes. |
| `CustomString16` | string | Extension string field 16 for schedule-level attributes. |
| `CustomString17` | string | Extension string field 17 for schedule-level attributes. |
| `CustomString18` | string | Extension string field 18 for schedule-level attributes. |
| `CustomString19` | string | Extension string field 19 for schedule-level attributes. |
| `CustomString20` | string | Extension string field 20 for schedule-level attributes. |
| `CustomString21` | string | Extension string field 21 for schedule-level attributes. |
| `CustomString22` | string | Extension string field 22 for schedule-level attributes. |
| `CustomString23` | string | Extension string field 23 for schedule-level attributes. |
| `CustomString24` | string | Extension string field 24 for schedule-level attributes. |
| `CustomString25` | string | Extension string field 25 for schedule-level attributes. |
| `CustomString26` | string | Extension string field 26 for schedule-level attributes. |
| `CustomString27` | string | Extension string field 27 for schedule-level attributes. |
| `CustomString28` | string | Extension string field 28 for schedule-level attributes. |
| `CustomString29` | string | Extension string field 29 for schedule-level attributes. |
| `CustomString30` | string | Extension string field 30 for schedule-level attributes. |
| `CustomString31` | string | Extension string field 31 for schedule-level attributes. |
| `CustomString32` | string | Extension string field 32 for schedule-level attributes. |
| `CustomString33` | string | Extension string field 33 for schedule-level attributes. |
| `CustomString34` | string | Extension string field 34 for schedule-level attributes. |
| `CustomString35` | string | Extension string field 35 for schedule-level attributes. |
| `CustomString36` | string | Extension string field 36 for schedule-level attributes. |
| `CustomString37` | string | Extension string field 37 for schedule-level attributes. |
| `CustomString38` | string | Extension string field 38 for schedule-level attributes. |
| `CustomString39` | string | Extension string field 39 for schedule-level attributes. |
| `CustomString40` | string | Extension string field 40 for schedule-level attributes. |
| `CustomString41` | string | Extension string field 41 for schedule-level attributes. |
| `CustomString42` | string | Extension string field 42 for schedule-level attributes. |
| `CustomString43` | string | Extension string field 43 for schedule-level attributes. |
| `CustomString44` | string | Extension string field 44 for schedule-level attributes. |
| `CustomString45` | string | Extension string field 45 for schedule-level attributes. |
| `CustomString46` | string | Extension string field 46 for schedule-level attributes. |
| `CustomString47` | string | Extension string field 47 for schedule-level attributes. |
| `CustomString48` | string | Extension string field 48 for schedule-level attributes. |
| `CustomString49` | string | Extension string field 49 for schedule-level attributes. |
| `CustomString50` | string | Extension string field 50 for schedule-level attributes. |

### Avalara.Excise.Determination.Engine.RestTransactionLineMeasure

| Property | Type | Description |
|---|---|---|
| `QuantityInd` | string |  |
| `UnitOfMeasure` | string |  |
| `MeasureValue` | number |  |

### Avalara.Excise.Determination.Engine.RestTransactionLineJurisdiction

| Property | Type | Description |
|---|---|---|
| `SpecialJurisdictionCode` | string |  |
| `SpecialJurisdictionType` | string |  |

### Avalara.Excise.Determination.Engine.RestTransactionResult

Represents the result of a REST transaction processing, including status, taxes, errors, and the complete transaction response.

| Property | Type | Description |
|---|---|---|
| `UserTranId` | string | The client-supplied transaction identifier echoed in this result. |
| `TranId` | integer | The system-assigned identifier for this calculated transaction. |
| `Status` | string | The processing status of this record. |
| `ReturnCode` | integer | The numeric outcome code for this tax calculation request. |
| `TotalTaxAmount` | number | The total calculated tax amount. |
| `TransactionTaxes` | array | Per-tax breakdown of amounts, rates, and jurisdictions for this transaction. |
| `TransactionErrors` | array | Errors or warnings encountered while calculating tax for this transaction. |
| `Transaction` | Avalara.Excise.Determination.Engine.RestTransactionResponse | The full transaction payload returned with this calculation result. |
| `UserReturnValue` | string | A value returned with the result for client-side correlation or downstream use. |

### Avalara.Excise.Determination.Engine.RestTransactionTax

Represents tax information for a REST transaction, including tax rates, amounts, jurisdictions, and calculation details.

| Property | Type | Description |
|---|---|---|
| `TransactionTaxAmounts` | array | Currency-level tax amounts that sum to this tax line when multiple currencies apply. |
| `SequenceId` | integer | The sequence of this tax line within the transaction tax breakdown. |
| `TransactionLine` | integer | The transaction line index this tax applies to, if the tax is line-specific. |
| `InvoiceLine` | integer | The invoice line index this tax applies to, when distinct from the transaction line. |
| `CountryCode` | string | The country for which this tax was determined. |
| `Jurisdiction` | string | The primary jurisdiction (for example state or province) for this tax. |
| `LocalJurisdiction` | string | The local jurisdiction (for example city or county) when tax is levied below the primary level. |
| `ProductCategory` | number | The product category used when matching this line to tax rules. |
| `TaxingLevel` | string | The government level at which this tax applies (for example federal, state, or local). |
| `TaxType` | string | The category of tax (for example excise, sales, or VAT). |
| `RateType` | string | How the rate is expressed (for example ad valorem, per unit, or specific). |
| `RateSubtype` | string | A finer classification of the rate within the rate type. |
| `CalculationTypeInd` | string | Indicates how the engine computed this tax (for example standard, bracket, or override). |
| `TaxRate` | number | The effective tax rate applied. |
| `TaxQuantity` | number | The quantity basis used to compute this tax. |
| `TaxAmount` | number | The tax amount for this line in the primary result currency before per-currency splits. |
| `TaxExemptionInd` | string | Whether this line is exempt or how exemption was applied. |
| `DeferredInd` | string | Whether collection or liability for this tax is deferred. |
| `PayableToCode` | string | The remittance destination or party type for this tax (for example jurisdiction or vendor). |
| `SalesTaxBaseAmount` | number | The taxable base used when sales or similar tax logic applies. |
| `LicenseNumber` | string | The license identifier tied to this tax determination when licensing rules apply. |
| `UserReturnedValue` | string | A client- or system-provided value echoed on this tax line for correlation. |
| `ScenarioId` | integer | The rule scenario that produced this tax line, when scenario-based determination is used. |
| `ScenarioTaxGroupId` | integer | The scenario tax group that produced this line, when grouping applies. |
| `ScenarioSequence` | integer | The ordering of this line within its scenario tax group. |
| `RateDescription` | string | Human-readable text describing the applied rate or bracket. |
| `Currency` | string | The currency in which the primary tax figures on this line are expressed. |
| `UnitOfMeasure` | string | The unit of measure for quantity-based rate application on this line. |
| `SubtotalInd` | string | Whether this line represents a subtotal or roll-up for display or reporting. |
| `StatusCode` | string | The processing status of this record. |
| `QuantityInd` | string | How quantity was interpreted for this tax line (for example gross, net, or billed). |
| `ReportingTaxAmount` | number | The tax amount restated in the reporting currency for compliance or ledger use. |
| `ReportingTaxQuantity` | number | The tax quantity restated for reporting purposes. |
| `ReportingTaxRate` | number | The effective rate in reporting terms when it differs from the transaction currency rate. |
| `ReportingTaxCurrency` | string | The currency used for reporting tax figures on this line. |
| `ReportingUnitOfMeasure` | string | The unit of measure used for reporting quantity on this line. |
| `EntityUseCode` | string | The buyer entity use or exemption code that influenced this determination. |
| `CustomString1` | string | First client-defined string extension returned on this tax line. |
| `CustomString2` | string | Second client-defined string extension returned on this tax line. |
| `CustomString3` | string | Third client-defined string extension returned on this tax line. |
| `CustomNumeric1` | number | First client-defined numeric extension returned on this tax line. |
| `CustomNumeric2` | number | Second client-defined numeric extension returned on this tax line. |
| `CustomNumeric3` | number | Third client-defined numeric extension returned on this tax line. |
| `TaxCode` | string | The product or tax product code that drove this determination. |
| `RateCode` | string | The rate table or schedule code applied to this line. |
| `VatCode` | string | The VAT classification code when value-added tax rules apply. |
| `PaymentTerms` | string | Payment terms associated with this tax line for accrual or cash-basis logic. |
| `AccountMapping` | string | General ledger or ERP account mapping suggested for this tax. |
| `RecoverabilityPercentage` | number | The percentage of this tax that is recoverable for the buyer, when applicable. |
| `RecoverableAmount` | number | The portion of the tax that is recoverable in recoverability scenarios. |
| `NonRecoverableAmount` | number | The portion of the tax that is not recoverable in recoverability scenarios. |
| `BuyerLicenseNumber` | string | The buyer license identifier used or validated for this tax line. |
| `BuyerLicenseDescription` | string | The description of the buyer license tied to this line. |
| `SellerLicenseNumber` | string | The seller license identifier used or validated for this tax line. |
| `SellerLicenseDescription` | string | The description of the seller license tied to this line. |
| `MiddlemanLicenseNumber` | string | The middleman or intermediary license identifier when the chain includes one. |
| `MiddlemanLicenseDescription` | string | The description of the middleman license tied to this line. |
| `CustomString4` | string | Fourth client-defined string extension returned on this tax line. |
| `CustomString5` | string | Fifth client-defined string extension returned on this tax line. |
| `CustomString6` | string | Sixth client-defined string extension returned on this tax line. |
| `CustomString7` | string | Seventh client-defined string extension returned on this tax line. |
| `CustomString8` | string | Eighth client-defined string extension returned on this tax line. |
| `CustomString9` | string | Ninth client-defined string extension returned on this tax line. |
| `CustomString10` | string | Tenth client-defined string extension returned on this tax line. |
| `CustomNumeric4` | number | Fourth client-defined numeric extension returned on this tax line. |
| `CustomNumeric5` | number | Fifth client-defined numeric extension returned on this tax line. |
| `CustomNumeric6` | number | Sixth client-defined numeric extension returned on this tax line. |
| `CustomNumeric7` | number | Seventh client-defined numeric extension returned on this tax line. |
| `CustomNumeric8` | number | Eighth client-defined numeric extension returned on this tax line. |
| `CustomNumeric9` | number | Ninth client-defined numeric extension returned on this tax line. |
| `CustomNumeric10` | number | Tenth client-defined numeric extension returned on this tax line. |

### Avalara.Excise.Determination.Engine.RestTransactionError

Represents an error that occurred during REST transaction processing, including error details and context.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | Sequence number ordering this error within the response. |
| `ErrorCode` | string | Code identifying the type or category of error. |
| `ErrorMessage` | string | Human-readable description of the error. |
| `ErrorLevelInd` | string | Severity of the error (for example Warning, Error, or Fatal). |
| `TransactionLine` | integer | One-based transaction line index where the error occurred, when applicable. |

### Avalara.Excise.Determination.Engine.RestTransactionResponse

Represents the response data for a REST transaction, containing calculated results and processed transaction information.

| Property | Type | Description |
|---|---|---|
| `TransactionLines` | array | Line-level results and inputs echoed for each item in the calculated transaction. |
| `TransactionExchangeRates` | array | Exchange rates applied when converting amounts across currencies on this transaction. |
| `TranId` | integer | The system-assigned identifier for this calculated transaction. |
| `CompanyId` | integer | The company context under which tax was calculated. |
| `ProcessInd` | string | How the engine treated this run (for example estimate, commit, or reverse). |
| `EffectiveDate` | string | The date tax rules and rates are evaluated against for this transaction. |
| `InvoiceNumber` | string | The invoice or document number associated with this transaction. |
| `InvoiceDate` | string | The invoice date supplied for this transaction. |
| `FuelUseCode` | string | The intended end use of fuel when fuel-specific excise rules apply. |
| `TitleTransferCode` | string | When title to the goods transfers for purposes of excise sourcing rules. |
| `TransactionType` | string | The business nature of the transaction (for example sale, purchase, or transfer). |
| `TransportationModeCode` | string | The primary mode used to move the product (for example truck, rail, or pipeline). |
| `AlternateTransportationMode` | string | A secondary or override transportation mode when multiple modes apply. |
| `SellerId` | integer | The seller party identifier in the host system when party-based rules apply. |
| `BuyerId` | integer | The buyer party identifier in the host system when party-based rules apply. |
| `PreviousSellerId` | integer | The upstream seller in a multi-leg supply chain, when modeled. |
| `NextBuyerId` | integer | The downstream buyer in a multi-leg supply chain, when modeled. |
| `MiddlemanId` | integer | An intermediary party in the chain when middleman rules apply. |
| `CustomsStatus` | string | Customs or cross-border status affecting duty and excise treatment. |
| `FormAPresentedInd` | string | Whether Form A or equivalent documentation was indicated for duty treatment. |
| `SimplifiedProcedureInd` | string | Whether a simplified customs procedure applies to this movement. |
| `Incoterms` | string | Incoterms governing risk, cost, and delivery for international trade context. |
| `PerspectiveBusinessType` | string | The reporting or filing perspective used when determining tax (for example seller vs buyer). |
| `ChainLeg` | string | Identifies the position of this movement in a multi-hop supply chain. |
| `OrderType` | string | The commercial order type influencing tax or exemption logic. |
| `TotalDyedUnits` | number | Total quantity of dyed fuel units across the transaction when dyed-fuel rules apply. |
| `TotalTaxes` | number | The total calculated tax amount for the whole transaction. |
| `TotalTaxesCurrency` | string | The currency in which total tax is expressed. |
| `TotalReportingTaxes` | number | Total tax restated in the reporting currency for compliance or GL posting. |
| `ReportingCurrency` | string | The currency used for reporting totals and related figures. |
| `ReportingUnitOfMeasure` | string | The unit of measure used for reporting quantity on the transaction. |
| `UserData` | string | Opaque client data echoed on the transaction for integration or audit. |
| `UserTranId` | string | The client-supplied transaction identifier echoed in the response. |
| `UserReturnedValue` | string | A value returned with the transaction for client-side correlation or downstream use. |
| `SourceSystem` | string | The originating system name or code when transactions are federated. |
| `CustomString1` | string | First client-defined string extension echoed on the transaction header. |
| `CustomString2` | string | Second client-defined string extension echoed on the transaction header. |
| `CustomString3` | string | Third client-defined string extension echoed on the transaction header. |
| `CustomString4` | string | Fourth client-defined string extension echoed on the transaction header. |
| `CustomString5` | string | Fifth client-defined string extension echoed on the transaction header. |
| `CustomString6` | string | Sixth client-defined string extension echoed on the transaction header. |
| `CustomString7` | string | Seventh client-defined string extension echoed on the transaction header. |
| `CustomString8` | string | Eighth client-defined string extension echoed on the transaction header. |
| `CustomString9` | string | Ninth client-defined string extension echoed on the transaction header. |
| `CustomString10` | string | Tenth client-defined string extension echoed on the transaction header. |
| `CustomNumeric1` | number | First client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric2` | number | Second client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric3` | number | Third client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric4` | number | Fourth client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric5` | number | Fifth client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric6` | number | Sixth client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric7` | number | Seventh client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric8` | number | Eighth client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric9` | number | Ninth client-defined numeric extension echoed on the transaction header. |
| `CustomNumeric10` | number | Tenth client-defined numeric extension echoed on the transaction header. |
| `CommitStatus` | string | Whether this transaction is committed, estimated, or in another lifecycle state in the host. |
| `AvaTaxTransactionType` | string | The mapped AvaTax document type when results are bridged to AvaTax. |
| `TotalDiscount` | number | The aggregate discount applied at the transaction level before or after tax, per product rules. |

### Avalara.Excise.Determination.Engine.RestTransactionTaxAmount

A currency-specific portion of tax within a single tax line in the calculation result.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | Orders this amount when multiple currency components apply to the same tax line. |
| `Currency` | string | The ISO or system currency code in which {Avalara.Excise.Determination.Engine.RestTransactionTaxAmount.TaxAmount} is expressed. |
| `TaxAmount` | number | The tax monetary value in the currency given by {Avalara.Excise.Determination.Engine.RestTransactionTaxAmount.Currency}. |

### Avalara.Excise.Determination.Engine.RestTransactionLineResponse

Represents the response data for a REST transaction line, containing calculated results and processed transaction line information.

| Property | Type | Description |
|---|---|---|
| `TransactionLineMeasures` | array | Supplemental measures (density, temperature, and similar) used in tax determination for this line. |
| `OriginSpecialJurisdictions` | array | Additional taxing jurisdictions applied at the origin when special sourcing rules apply. |
| `DestinationSpecialJurisdictions` | array | Additional taxing jurisdictions applied at the destination when special sourcing rules apply. |
| `SaleSpecialJurisdictions` | array | Additional taxing jurisdictions applied at the sale location when special sourcing rules apply. |
| `TransactionLine` | integer | The line index within the transaction used to correlate taxes and errors. |
| `InvoiceLine` | integer | The invoice line index when it differs from the transaction line sequence. |
| `BillOfLadingNumber` | string | The shipping document identifier tied to this movement, when provided. |
| `BillOfLadingDate` | string | The date on the bill of lading or equivalent shipping document. |
| `MovementStartDate` | string | The start of the movement or delivery window for this line. |
| `MovementEndDate` | string | The end of the movement or delivery window for this line. |
| `ProductCode` | string | The primary product identifier used to match excise product rules. |
| `AlternateProductCode` | string | An alternate catalog or host code for the same product when multiple identifiers exist. |
| `AlternativeFuelContent` | number | The share of alternative fuel content when blend or bifuel rules apply. |
| `BlendToProductCode` | string | The target product code when this line represents a blend into another product. |
| `BlendToAltProductCode` | string | The alternate code for the blend target product when applicable. |
| `BlendToAltFuelContent` | number | The alternative fuel content of the blend target when relevant to the calculation. |
| `BlendToInd` | string | Whether this line is modeled as blending into another product. |
| `UnitPrice` | number | The price per primary unit of measure before tax. |
| `AlternateUnitPrice` | number | The price per unit in the alternate unit of measure when dual pricing is used. |
| `NetUnits` | number | The quantity after deductions (returns, losses) used as a tax basis when applicable. |
| `GrossUnits` | number | The total physical quantity before deductions on this line. |
| `BilledUnits` | number | The quantity invoiced or charged to the customer on this line. |
| `UnitOfMeasure` | string | The primary unit of measure for net, gross, or billed quantities. |
| `AlternateUnitOfMeasure` | string | The alternate unit of measure for quantity reporting or conversion. |
| `UnitQuantity` | number | A distinct quantity basis (for example per-container count) used alongside weight or volume. |
| `UnitQuantityUnitOfMeasure` | string | The unit of measure for the unit quantity value. |
| `UnitQuantityAltUnitOfMeasure` | string | The alternate unit of measure for the unit quantity value. |
| `UnitVolume` | number | The volume of one selling unit (for example per bottle or drum). |
| `UnitVolumeUnitOfMeasure` | string | The unit of measure for unit volume. |
| `UnitVolumeAltUnitOfMeasure` | string | The alternate unit of measure for unit volume. |
| `UnitWeight` | number | The weight of one selling unit when weight-based rules apply. |
| `UnitWeightUnitOfMeasure` | string | The unit of measure for unit weight. |
| `UnitWeightAltUnitOfMeasure` | string | The alternate unit of measure for unit weight. |
| `UnitLength` | number | The length of one selling unit when length-based rules apply. |
| `UnitLengthUnitOfMeasure` | string | The unit of measure for unit length. |
| `UnitLengthAltUnitOfMeasure` | string | The alternate unit of measure for unit length. |
| `LineAmount` | number | The extended line value in the line currency before or after tax per product configuration. |
| `AlternateLineAmount` | number | The line value expressed in an alternate currency or basis when dual amounts are returned. |
| `FreightUnitPrice` | number | The freight rate per freight unit for this line. |
| `FreightType` | string | The kind of freight charge (for example prepaid, collect) affecting tax treatment. |
| `FreightLineAmount` | number | The total freight charge allocated to this line. |
| `Currency` | string | The currency in which line monetary amounts are expressed. |
| `OriginCountryCode` | string | The country from which the product ships or originates for sourcing. |
| `OriginJurisdiction` | string | The state or province of the origin location. |
| `OriginCounty` | string | The county of the origin location when sub-state sourcing applies. |
| `OriginCity` | string | The city of the origin location. |
| `OriginPostalCode` | string | The postal or ZIP code of the origin location. |
| `OriginType` | string | The category of origin site (for example terminal, rack, or retail). |
| `OriginId` | integer | The host-system identifier for the origin location when locations are master-managed. |
| `OriginOutCityLimitInd` | string | Whether the origin lies outside incorporated city limits for local tax boundaries. |
| `OriginCustomId` | string | A client-defined origin location key echoed in the response. |
| `OriginSpecialJurisdictionInd` | string | Whether additional origin special jurisdictions are in effect on this line. |
| `OriginExciseWarehouse` | string | The bonded or excise warehouse identifier at origin when duty suspension applies. |
| `OriginAddress1` | string | The first line of the street address at origin. |
| `OriginAddress2` | string | The second line of the street address at origin. |
| `OriginAirportCode` | string | The IATA or system airport code when origin is an air node. |
| `DestinationCountryCode` | string | The country where the product is delivered or consumed for sourcing. |
| `DestinationJurisdiction` | string | The state or province of the destination location. |
| `DestinationCounty` | string | The county of the destination location when sub-state sourcing applies. |
| `DestinationCity` | string | The city of the destination location. |
| `DestinationPostalCode` | string | The postal or ZIP code of the destination location. |
| `DestinationType` | string | The category of destination site (for example delivery point or retail outlet). |
| `DestinationId` | integer | The host-system identifier for the destination location when locations are master-managed. |
| `DestinationOutCityLimitInd` | string | Whether the destination lies outside incorporated city limits for local tax boundaries. |
| `DestinationCustomId` | string | A client-defined destination location key echoed in the response. |
| `DestinationSpecialJurisdictionInd` | string | Whether additional destination special jurisdictions are in effect on this line. |
| `DestinationExciseWarehouse` | string | The bonded or excise warehouse identifier at destination when duty suspension applies. |
| `DestinationAddress1` | string | The first line of the street address at destination. |
| `DestinationAddress2` | string | The second line of the street address at destination. |
| `DestinationAirportCode` | string | The IATA or system airport code when destination is an air node. |
| `SaleCustomId` | string | A client-defined key for the place of sale echoed in the response. |
| `SaleCountryCode` | string | The country where the retail or point-of-sale event occurs when sale sourcing is used. |
| `SaleJurisdiction` | string | The state or province of the sale location. |
| `SaleCounty` | string | The county of the sale location when sub-state sourcing applies. |
| `SaleCity` | string | The city of the sale location. |
| `SalePostalCode` | string | The postal or ZIP code of the sale location. |
| `SaleType` | string | The category of sale site (for example store, kiosk, or online). |
| `SaleLocation` | string | The host or client code identifying the specific sale outlet or register. |
| `SaleOutCityLimitInd` | string | Whether the sale location lies outside incorporated city limits for local tax boundaries. |
| `SaleSpecialJurisdictionInd` | string | Whether additional sale-location special jurisdictions are in effect on this line. |
| `SaleExciseWarehouse` | string | The bonded or excise warehouse identifier at the sale location when applicable. |
| `SaleAddress1` | string | The first line of the street address at the sale location. |
| `SaleAddress2` | string | The second line of the street address at the sale location. |
| `SaleAirportCode` | string | The IATA or system airport code when the sale location is an air node. |
| `CounterCustomId` | string | A client-defined key for the counterparty location echoed in the response. |
| `CounterCountryCode` | string | The country of the counterparty for party-based sourcing or licensing. |
| `CounterJurisdiction` | string | The state or province of the counterparty location. |
| `CounterCounty` | string | The county of the counterparty location when sub-state rules apply. |
| `CounterCity` | string | The city of the counterparty location. |
| `CounterPostalCode` | string | The postal or ZIP code of the counterparty location. |
| `CounterType` | string | The category of counterparty site (for example dealer, distributor, or end user). |
| `CounterParty` | string | The host or client identifier for the counterparty when party master data is used. |
| `CounterOutCityLimitInd` | string | Whether the counterparty lies outside incorporated city limits for local tax boundaries. |
| `CounterSpecialJurisdictionInd` | string | Whether additional counterparty special jurisdictions are in effect on this line. |
| `CounterExciseWarehouse` | string | The bonded or excise warehouse identifier associated with the counterparty when applicable. |
| `CounterFiscalRepInd` | string | Whether a fiscal representative is indicated for the counterparty under EU or similar rules. |
| `CounterAddress1` | string | The first line of the counterparty street address. |
| `CounterAddress2` | string | The second line of the counterparty street address. |
| `CounterAirportCode` | string | The IATA or system airport code when the counterparty location is an air node. |
| `UserData` | string | Opaque client-defined payload echoed with this line in the response. |
| `CustomString1` | string | First client-defined string extension returned on this line. |
| `CustomString2` | string | Second client-defined string extension returned on this line. |
| `CustomString3` | string | Third client-defined string extension returned on this line. |
| `CustomString4` | string | Fourth client-defined string extension returned on this line. |
| `CustomString5` | string | Fifth client-defined string extension returned on this line. |
| `CustomString6` | string | Sixth client-defined string extension returned on this line. |
| `CustomString7` | string | Seventh client-defined string extension returned on this line. |
| `CustomString8` | string | Eighth client-defined string extension returned on this line. |
| `CustomString9` | string | Ninth client-defined string extension returned on this line. |
| `CustomString10` | string | Tenth client-defined string extension returned on this line. |
| `CustomNumeric1` | number | First client-defined numeric extension returned on this line. |
| `CustomNumeric2` | number | Second client-defined numeric extension returned on this line. |
| `CustomNumeric3` | number | Third client-defined numeric extension returned on this line. |
| `CustomNumeric4` | number | Fourth client-defined numeric extension returned on this line. |
| `CustomNumeric5` | number | Fifth client-defined numeric extension returned on this line. |
| `CustomNumeric6` | number | Sixth client-defined numeric extension returned on this line. |
| `CustomNumeric7` | number | Seventh client-defined numeric extension returned on this line. |
| `CustomNumeric8` | number | Eighth client-defined numeric extension returned on this line. |
| `CustomNumeric9` | number | Ninth client-defined numeric extension returned on this line. |
| `CustomNumeric10` | number | Tenth client-defined numeric extension returned on this line. |
| `NthTimeSale` | number | Ordinal indicating which sale in a series this line represents for recurring or tiered rules. |
| `TaxIncluded` | boolean | Whether excise or sales tax is included in the stated prices on this line. |
| `DiscountAmount` | number | Discount amount applied to this line for tax base or pricing purposes. |

### Avalara.Excise.Determination.Engine.AdjustTransactionRequest

Represents a request to adjust an existing transaction in the system.
This class contains the information needed to modify transaction data,
including the reason for adjustment, description, and the new transaction data.

| Property | Type | Description |
|---|---|---|
| `adjustmentReason` | string | Gets or sets the reason for adjusting the transaction.
Specifies the type of adjustment being made (e.g., "CORRECTION", "REFUND", "VOID"). |
| `adjustmentDescription` | string | Gets or sets a human-readable description explaining why the transaction is being adjusted.
Provides additional context and justification for the adjustment request. |
| `newTransaction` | Avalara.Excise.Determination.Engine.RestTransaction | Gets or sets the new transaction data that will replace or modify the existing transaction.
Contains the updated transaction information after the adjustment is applied. |

### Avalara.Excise.Determination.Engine.UpdateReturnDataRequest

Represents a request to update return data for transaction processing.
This class contains the transaction lines and schedule information needed to update
return data for tax determination and reporting purposes.

| Property | Type | Description |
|---|---|---|
| `TransactionLines` | array | Gets or sets a list of transaction lines that need return data updates.
Each transaction line contains specific information about individual line items
that require return data modifications. |
| `TransactionSchedule` | Avalara.Excise.Determination.Engine.RestTransactionSchedule | Gets or sets the transaction schedule that defines the timing and structure
of the transaction processing for return data updates. |

### Avalara.Excise.Determination.Engine.UpdateReturnDataTransactionLine

Represents a single transaction line that requires return data updates.
This class contains the specific line item information and schedule details
needed to process return data modifications for individual transaction lines.

| Property | Type | Description |
|---|---|---|
| `InvoiceLine` | integer | Gets or sets the invoice line number that identifies the specific line item
within a transaction that requires return data updates. |
| `TransactionLineSchedule` | Avalara.Excise.Determination.Engine.RestTransactionLineSchedule | Gets or sets the transaction line schedule that defines the timing and structure
for processing return data updates on this specific transaction line. |

### Avalara.Excise.Determination.Engine.RestTransactionResultSummary

Represents a summary of REST transaction results including counts and processing statistics.

| Property | Type | Description |
|---|---|---|
| `TransactionResults` | array | The individual excise tax calculation results included in this batch response. |
| `NumberProcessed` | integer | The number of transactions submitted in this batch. |
| `NumberSuccess` | integer | The number of transactions that completed tax calculation successfully. |
| `NumberFailed` | integer | The number of transactions that failed during tax processing. |

### Avalara.Excise.Common.Contracts.Services.BusinessEntityImportRequest

Represents a request object for importing business entities through the REST service.
This class contains all the necessary information to perform a business entity import operation,
including the entities to import, import configuration options, and matching behavior settings.

| Property | Type | Description |
|---|---|---|
| `BusinessEntities` | array | Gets or sets an array of business entities to be imported.
Each business entity contains the data that will be processed and imported into the system. |
| `ImportName` | string | Gets or sets the name identifier for this import operation.
This name is used to identify and track the import operation in logs and reports. |
| `UpdateMatchesMode` | string | Gets or sets the update matching mode that determines how existing records are handled during import.
This setting controls whether and how the system should match and update existing business entities
when duplicates are found during the import process. |
| `TerminateNewRecords` | boolean | Gets or sets a boolean value indicating whether new records should be terminated after import.
When true, newly imported records will be marked as terminated, typically used for historical data imports. |
| `CreateAllAccountTypes` | boolean | Gets or sets a boolean value indicating whether all account types should be created for imported entities.
When true, the system will automatically create all supported account types for each imported business entity. |
| `LoadId` | string | Gets or sets the unique identifier for this import load operation.
This GUID is used to correlate related import operations and track the overall import process. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessEntity

Data Contract Class - BusinessEntityDC for REST services.
This class represents a business entity with associated accounts and identification information.
Business entities can become obsolete over time, managed through the IObsoletable interface.

| Property | Type | Description |
|---|---|---|
| `CustomId` | string | The client-defined identifier for this business entity. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `TradeName` | string | The doing-business-as or trade name. |
| `LegalName` | string | The legal name of the business. |
| `NameControl` | string | The name control characters used for tax or regulatory matching. |
| `Address1` | string | The first line of the street address. |
| `Address2` | string | The second line of the street address. |
| `City` | string | The city or locality. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `PostalCode` | string | The postal or ZIP code. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `County` | string | The county name. |
| `CountyCode` | string | The county code. |
| `AlternateJurisdiction` | string | An alternate jurisdiction designation when applicable. |
| `BusinessAccounts` | array | The business accounts (licenses or registrations) associated with this entity. |
| `BusinessEntityIdCodes` | array | The identification codes (by country and type) associated with the business entity. |
| `CustomIdPriority` | integer | The match priority when resolving the entity by custom identifier. |
| `IdCodeAndIdTypePriority` | integer | The match priority when resolving the entity by ID type and ID code. |
| `LegalNamePriority` | integer | The match priority when resolving the entity by legal name. |
| `BusinessEntityMappingId` | string | The client-supplied correlation identifier for this entity in import or mapping operations. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessAccount

Represents a business account (license or registration) tied to a business entity for excise tax purposes.

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `BusinessType` | string | The category of business or license type for this account. |
| `BusinessSubType` | string | The sub-type or secondary classification for this account. |
| `CustomId` | string | The client-defined identifier for this business account. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `LicenseNumber` | string | The license or registration number. |
| `LicensePercentage` | number | The license percentage when applicable to the registration. |
| `BusinessAccountMappingId` | string | The client-supplied correlation identifier for this account in import or mapping operations. |
| `LicenseExpirationDate` | string | The date when the license or registration expires. |
| `LicenseDescription` | string | A description of the license or registration. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessEntityIdCode

Represents business entity identification codes for REST services, containing ID types and codes by country.

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `IdType` | string | The type of identification (e.g., tax ID category) for this code. |
| `IdCode` | string | The identification number or code value. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessEntityImportResultSummary

Summarizes the results of a business entity import operation, including counts and per-record results.

| Property | Type | Description |
|---|---|---|
| `BusinessEntityResults` | array | Per-entity import results from the operation. |
| `Status` | string | The processing status of the import operation (e.g., Inserted, Updated, Failed). |
| `NumberEntitiesProcessed` | integer | The total number of business entities processed during the import. |
| `NumberEntitiesInserted` | integer | The total number of business entities inserted during the import. |
| `NumberEntitiesUpdated` | integer | The total number of business entities updated during the import. |
| `NumberEntitiesFailed` | integer | The total number of business entities that failed during the import. |
| `NumberIdCodesProcessed` | integer | The total number of identification codes processed during the import. |
| `NumberIdCodesInserted` | integer | The total number of identification codes inserted during the import. |
| `NumberIdCodesUpdated` | integer | The total number of identification codes updated during the import. |
| `NumberIdCodesFailed` | integer | The total number of identification codes that failed during the import. |
| `NumberAccountsProcessed` | integer | The total number of business accounts processed during the import. |
| `NumberAccountsInserted` | integer | The total number of business accounts inserted during the import. |
| `NumberAccountsUpdated` | integer | The total number of business accounts updated during the import. |
| `NumberAccountsFailed` | integer | The total number of business accounts that failed during the import. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessEntityResult

Represents the import result for a business entity, including status and any error details.

| Property | Type | Description |
|---|---|---|
| `BusinessAccounts` | array | Per-account import results for this business entity. |
| `BusinessEntityIdCodes` | array | Import results for each identification code on this business entity. |
| `BusinessEntityErrors` | array | Errors that occurred for this business entity during import. |
| `BusinessEntityId` | integer | The unique identifier of the business entity after import. |
| `CustomId` | string | The client-defined identifier for this business entity. |
| `EffectiveDate` | string | The effective date in UTC (serialized form). |
| `Status` | string | The processing status of this record (e.g., Inserted, Updated, Failed). |
| `Message` | string | A human-readable status or detail message for this result. |
| `BusinessEntityMappingId` | string | The client-supplied correlation identifier echoed from the import request. |
| `LegalName` | string | The legal name of the business. |
| `TradeName` | string | The doing-business-as or trade name. |
| `NameControl` | string | The name control characters used for tax or regulatory matching. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessAccountResult

Represents the import result for a business account, including status and any error details.

| Property | Type | Description |
|---|---|---|
| `BusinessAccountErrors` | array | Errors that occurred for this business account during import. |
| `BusinessAccountId` | integer | The unique identifier of the business account after import. |
| `BusinessAccountMappingId` | string | The client-supplied correlation identifier echoed from the import request. |
| `CustomId` | string | The client-defined identifier for this business account. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `BusinessType` | string | The category of business or license type for this account. |
| `BusinessSubType` | string | The sub-type or secondary classification for this account. |
| `LicenseNumber` | string | The license or registration number. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `Status` | string | The processing status of this record (e.g., Inserted, Updated, Failed). |
| `Message` | string | A human-readable status or detail message for this result. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessEntityIdCodeResult

Represents the import result for a business entity identification code, including status and any error details.

| Property | Type | Description |
|---|---|---|
| `BusinessEntityIdCodeErrors` | array | Errors that occurred for this identification code during import. |
| `BusinessEntityId` | integer | The unique identifier of the parent business entity. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `IdType` | string | The type of identification for this code. |
| `IdCode` | string | The identification number or code value. |
| `Status` | string | The processing status of this record (e.g., Inserted, Updated, Failed). |
| `Message` | string | A human-readable status or detail message for this result. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessEntityError

Represents an error that occurred during import for a business entity.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | The sequence number of this error when multiple errors are returned. |
| `ErrorCode` | string | The machine-readable error code. |
| `ErrorMessage` | string | The error message describing why the operation failed. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessAccountError

Represents an error that occurred during import for a business account.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | The sequence number of this error when multiple errors are returned. |
| `ErrorCode` | string | The machine-readable error code. |
| `ErrorMessage` | string | The error message describing why the operation failed. |

### Avalara.Excise.Common.Contracts.Services.RestBusinessEntityIdCodeError

Represents an error that occurred during import for a business entity identification code.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | The sequence number of this error when multiple errors are returned. |
| `ErrorCode` | string | The machine-readable error code. |
| `ErrorMessage` | string | The error message describing why the operation failed. |

### Avalara.Excise.Common.Contracts.BusinessObjects.StImportHeaderDC

Data Contract Class - StImportHeaderDC

| Property | Type | Description |
|---|---|---|
| `CompanyId` | integer | Maps to company_id as int |
| `LoadId` | string | Maps to load_id as uniqueidentifier |
| `StatusInd` | string | Maps to status_ind as nchar(1) |
| `LoadDate` | string | Maps to load_date as datetime |
| `Description` | string | Maps to description as varchar(512) |
| `TotalBatches` | integer | Maps to total_batches as int |
| `TotalPassedBatches` | integer | Maps to total_passed_batches as int |
| `TotalFailedBatches` | integer | Maps to total_failed_batches as int |
| `TotalSourceRecords` | integer | Maps to total_source_records as int |
| `TotalInsertedRecords` | integer | Maps to total_inserted_records as int |
| `ProcessTimeElapsedSeconds` | integer | Maps to process_time_elapsed_seconds as int |
| `UnassignedDocumentId` | integer | Maps to unassigned_document_id as int |
| `CreatedBy` | string | Maps to created_by as nvarchar(128) |
| `CreatedDate` | string | Maps to created_date as datetime |
| `UpdatedBy` | string | Maps to updated_by as nvarchar(128) |
| `UpdatedDate` | string | Maps to updated_date as datetime |
| `DeletedDate` | string | Maps to deleted_date as datetime |
| `Checksum` | number | Maps to checksum as decimal(29,10) |
| `UnassignedSourceRecords` | integer | Maps to unassigned_source_records as int |
| `UnassignedOverallTotal` | integer | Maps to unassigned_overall_total as int |
| `StiVersionNumber` | string | Maps to sti_version_number as nvarchar(255) |

### Avalara.Excise.Website.Api.ApiCollectionResponse[Avalara.Excise.Common.Contracts.BusinessObjects.StImportHeaderDC]

| Property | Type | Description |
|---|---|---|
| `Offset` | integer |  |
| `Limit` | integer |  |
| `Data` | array |  |
| `Total` | integer |  |
| `Errors` | array |  |

### System.Net.Http.PushStreamContent

| Property | Type | Description |
|---|---|---|
| `Headers` | array |  |

### System.Collections.Generic.KeyValuePair[System.String,System.Collections.Generic.IEnumerable[System.String]]

| Property | Type | Description |
|---|---|---|
| `key` | string |  |
| `value` | array |  |

### Avalara.Excise.Common.Contracts.Services.ItemCodeImportRequest

Represents a request object for importing item codes through the REST service.
This class contains all the necessary information to perform an item code import operation,
including the item codes to import, import configuration options, and matching behavior settings.

| Property | Type | Description |
|---|---|---|
| `ItemCodes` | array | Gets or sets an array of item codes to be imported.
Each item code contains the data that will be processed and imported into the system
for tax classification and product identification purposes. |
| `ImportName` | string | Gets or sets the name identifier for this import operation.
This name is used to identify and track the import operation in logs and reports. |
| `UpdateMatchesMode` | string | Gets or sets the update matching mode that determines how existing records are handled during import.
This setting controls whether and how the system should match and update existing item codes
when duplicates are found during the import process. |
| `LoadId` | string | Gets or sets the unique identifier for this import load operation.
This GUID is used to correlate related import operations and track the overall import process. |

### Avalara.Excise.Common.Contracts.Services.RestItemCode

Represents an item code for REST services, containing code information, dates, and tax code mappings.

| Property | Type | Description |
|---|---|---|
| `ItemCode` | string | The item code value. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `LockedDate` | string | The date when the record was locked for editing. |
| `Description` | string | The description of the item code. |
| `ItemCodeMappingId` | string | The client-supplied identifier that correlates this item code with the import request. |

### Avalara.Excise.Common.Contracts.Services.RestItemCodeImportResultSummary

Summarizes the results of an item code import operation, including counts and per-record results.

| Property | Type | Description |
|---|---|---|
| `ItemCodeResults` | array | Per-record import results for each item code. |
| `Status` | string | The overall processing status of the import operation. |
| `NumberProcessed` | integer | The total number of records processed during the import. |
| `NumberInserted` | integer | The total number of records inserted during the import. |
| `NumberUpdated` | integer | The total number of records updated during the import. |
| `NumberFailed` | integer | The total number of records that failed during the import. |

### Avalara.Excise.Common.Contracts.Services.RestItemCodeResult

Represents the import result for an item code, including status and any error details.

| Property | Type | Description |
|---|---|---|
| `ItemCodeMappingId` | string | The client-supplied mapping identifier from the import request. |
| `ItemCodeId` | integer | System identifier for the item code record. |
| `ItemCode` | string | The business item code value. |
| `Description` | string | Human-readable description of the item code. |
| `EffectiveDate` | string | Date when this item code becomes effective. |
| `Status` | string | Processing outcome of the item code operation (for example Inserted, Updated, or Failed). |
| `Message` | string | Status or informational message for this item code import result. |

### Avalara.Excise.Common.Contracts.Services.LocationImportRequest

Represents a request object for importing location data through the REST service.
This class contains all the necessary information to perform a location import operation,
including the locations to import, import configuration options, matching behavior settings,
and exact match criteria for various location attributes.

| Property | Type | Description |
|---|---|---|
| `Locations` | array | Gets or sets an array of locations to be imported.
Each location contains the data that will be processed and imported into the system
for tax compliance and regulatory reporting purposes. |
| `ImportName` | string | Gets or sets the name identifier for this import operation.
This name is used to identify and track the import operation in logs and reports. |
| `UpdateMatchesMode` | string | Gets or sets the update matching mode that determines how existing records are handled during import.
This setting controls whether and how the system should match and update existing locations
when duplicates are found during the import process. |
| `TerminateNewRecords` | boolean | Gets or sets a boolean value indicating whether new records should be terminated after import.
When true, newly imported records will be marked as terminated, typically used for historical data imports. |
| `ExactMatchCountryCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on country code.
When true, only locations with identical country codes will be considered matches. |
| `ExactMatchJurisdiction` | boolean | Gets or sets a boolean value indicating whether to require exact matching on jurisdiction.
When true, only locations with identical jurisdictions will be considered matches. |
| `ExactMatchDescription` | boolean | Gets or sets a boolean value indicating whether to require exact matching on description.
When true, only locations with identical descriptions will be considered matches. |
| `ExactMatchAddress1` | boolean | Gets or sets a boolean value indicating whether to require exact matching on address line 1.
When true, only locations with identical first address lines will be considered matches. |
| `ExactMatchAddress2` | boolean | Gets or sets a boolean value indicating whether to require exact matching on address line 2.
When true, only locations with identical second address lines will be considered matches. |
| `ExactMatchCity` | boolean | Gets or sets a boolean value indicating whether to require exact matching on city.
When true, only locations with identical cities will be considered matches. |
| `ExactMatchPostalCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on postal code.
When true, only locations with identical postal codes will be considered matches. |
| `ExactMatchAlternateJurisdiction` | boolean | Gets or sets a boolean value indicating whether to require exact matching on alternate jurisdiction.
When true, only locations with identical alternate jurisdictions will be considered matches. |
| `ExactMatchAlternateFacilityNumber` | boolean | Gets or sets a boolean value indicating whether to require exact matching on alternate facility number.
When true, only locations with identical alternate facility numbers will be considered matches. |
| `ExactMatchAirportCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on airport code.
When true, only locations with identical airport codes will be considered matches. |
| `ExactMatchCounty` | boolean | Gets or sets a boolean value indicating whether to require exact matching on county name.
When true, only locations with identical county names will be considered matches. |
| `ExactMatchCountyCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on county code.
When true, only locations with identical county codes will be considered matches. |
| `ExactMatchDepNumber` | boolean | Gets or sets a boolean value indicating whether to require exact matching on depot number.
When true, only locations with identical depot numbers will be considered matches. |
| `ExactMatchLocationType` | boolean | Gets or sets a boolean value indicating whether to require exact matching on location type.
When true, only locations with identical location types will be considered matches. |
| `ExactMatchOutsideCityLimit` | boolean | Gets or sets a boolean value indicating whether to require exact matching on outside city limit indicator.
When true, only locations with identical outside city limit indicators will be considered matches. |
| `ExactMatchStateAssignedCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on state assigned code.
When true, only locations with identical state assigned codes will be considered matches. |
| `ExactMatchSiteCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on site code.
When true, only locations with identical site codes will be considered matches. |
| `ExactMatchSpecialJurisdiction` | boolean | Gets or sets a boolean value indicating whether to require exact matching on special jurisdiction indicator.
When true, only locations with identical special jurisdiction indicators will be considered matches. |
| `LoadId` | string | Gets or sets the unique identifier for this import load operation.
This GUID is used to correlate related import operations and track the overall import process. |

### Avalara.Excise.Common.Contracts.Services.RestLocation

Represents a location for REST services, including address, identifiers, and tax jurisdiction fields.

| Property | Type | Description |
|---|---|---|
| `LocationMappingId` | string | The client-supplied identifier that correlates this location with the import request. |
| `LocationId` | integer | The unique identifier of the location record. |
| `MasterCompanyId` | integer | The unique identifier of the master company that owns this record. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `TerminalCode` | string | The terminal code associated with this location. |
| `CustomId` | string | A client-defined identifier for this location. |
| `Description` | string | A human-readable description of the location. |
| `Address1` | string | The first line of the street address. |
| `Address2` | string | The second line of the street address. |
| `City` | string | The city name. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `PostalCode` | string | The postal or ZIP code. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `County` | string | The county name. |
| `CountyCode` | string | The county code. |
| `AirportCode` | string | The airport code, if applicable. |
| `AlternateJurisdiction` | string | An alternate jurisdiction designation, if applicable. |
| `AlternateFacilityNumber` | string | An alternate facility registration number. |
| `DepNumber` | string | The DEP or related regulatory identifier for this location. |
| `LocationType` | string | The type classification of the location. |
| `OutsideCityLimitInd` | string | Whether the location is outside city limits (Yes or No). |
| `StateAssignedCode` | string | The code assigned to this location by the state. |
| `SiteCode` | string | The site code for this location. |
| `SpecialJurisdiction` | string | A special jurisdiction designation, if applicable. |

### Avalara.Excise.Common.Contracts.Services.RestLocationImportResultSummary

Summarizes the results of a location import operation, including counts and per-record results.

| Property | Type | Description |
|---|---|---|
| `LocationResults` | array | The per-record import results for each location. |
| `Status` | string | The overall processing status of the import operation. |
| `NumberProcessed` | integer | The total number of records processed during the import. |
| `NumberInserted` | integer | The count of locations successfully inserted during the import. |
| `NumberUpdated` | integer | The total number of records updated during the import. |
| `NumberFailed` | integer | The total number of records that failed during the import. |

### Avalara.Excise.Common.Contracts.Services.RestLocationResult

Represents the result of a location import operation for REST services.
This class contains the outcome of processing a location during import, including success/failure status,
error information, and complete location details for excise tax compliance.

| Property | Type | Description |
|---|---|---|
| `LocationErrors` | array | Errors encountered while processing this location during import. |
| `LocationId` | integer | The unique identifier of the location. |
| `LocationMappingId` | string | Maps back to the passed in MappingId |
| `CustomId` | string | A client-defined identifier for this record. |
| `TerminalCode` | string | The terminal code. |
| `Description` | string | A human-readable description. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `Address1` | string | The first line of the street address. |
| `City` | string | The city name. |
| `County` | string | The county name. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `AlternateFacilityNumber` | string | An alternate facility or site identifier. |
| `Status` | string | The processing status of this record (e.g., Inserted, Updated, Failed). |
| `Message` | string | A status or informational message for this import result. |

### Avalara.Excise.Common.Contracts.Services.RestLocationError

Represents an error that occurred during import for a location.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | The sequence number of this error within the import response. |
| `ErrorCode` | string | The application-specific error code. |
| `ErrorMessage` | string | The error message describing why the operation failed. |

### Avalara.Excise.Common.Contracts.Services.ManufacturerImportRequest

Represents a request object for importing manufacturer data through the REST service.
This class contains all the necessary information to perform a manufacturer import operation,
including the manufacturers to import, import configuration options, matching behavior settings,
and jurisdiction update preferences.

| Property | Type | Description |
|---|---|---|
| `Manufacturers` | array | Gets or sets an array of manufacturers to be imported.
Each manufacturer contains the data that will be processed and imported into the system
for tax compliance and regulatory reporting purposes. |
| `ImportName` | string | Gets or sets the name identifier for this import operation.
This name is used to identify and track the import operation in logs and reports. |
| `UpdateMatchesMode` | string | Gets or sets the update matching mode that determines how existing records are handled during import.
This setting controls whether and how the system should match and update existing manufacturers
when duplicates are found during the import process. |
| `ManufacturerJurisdictionUpdateMode` | string | Gets or sets the manufacturer jurisdiction update mode that controls how jurisdiction information
is updated during the import process. |
| `ExactMatchCountryCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on country code.
When true, only manufacturers with identical country codes will be considered matches. |
| `ExactMatchJurisdiction` | boolean | Gets or sets a boolean value indicating whether to require exact matching on jurisdiction.
When true, only manufacturers with identical jurisdictions will be considered matches. |
| `ExactMatchLegalName` | boolean | Gets or sets a boolean value indicating whether to require exact matching on legal name.
When true, only manufacturers with identical legal names will be considered matches. |
| `ExactMatchMsaStatus` | boolean | Gets or sets a boolean value indicating whether to require exact matching on MSA status.
When true, only manufacturers with identical Metropolitan Statistical Area status will be considered matches. |
| `ExactMatchIdTypeIdCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on ID type and ID code.
When true, only manufacturers with identical ID type and ID code combinations will be considered matches. |
| `ExactMatchCustomId` | boolean | Gets or sets a boolean value indicating whether to require exact matching on custom ID.
When true, only manufacturers with identical custom IDs will be considered matches. |
| `ExactMatchLicenseNumber` | boolean | Gets or sets a boolean value indicating whether to require exact matching on license number.
When true, only manufacturers with identical license numbers will be considered matches. |
| `ExactMatchTradeName` | boolean | Gets or sets a boolean value indicating whether to require exact matching on trade name.
When true, only manufacturers with identical trade names will be considered matches. |
| `ExactMatchManufacturerCode` | boolean | Gets or sets a boolean value indicating whether to require exact matching on manufacturer code.
When true, only manufacturers with identical manufacturer codes will be considered matches. |
| `TerminateNewRecords` | boolean | Gets or sets a boolean value indicating whether new records should be terminated after import.
When true, newly imported records will be marked as terminated, typically used for historical data imports. |
| `LoadId` | string | Gets or sets the unique identifier for this import load operation.
This GUID is used to correlate related import operations and track the overall import process. |

### Avalara.Excise.Common.Contracts.Services.RestManufacturer

Represents a manufacturer, including registration details, physical and mailing addresses, and associated jurisdictions.

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `MsaStatus` | string | The master settlement agreement (MSA) status. |
| `IdType` | string | The type of business entity identifier. |
| `IdCode` | string | The business entity identifier value. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `LicenseNumber` | string | The license number. |
| `LegalName` | string | The legal business name. |
| `TradeName` | string | The trade or doing-business-as name. |
| `PhysicalAddress1` | string | The first line of the physical street address. |
| `PhysicalAddress2` | string | The second line of the physical street address. |
| `PhysicalCity` | string | The city for the physical address. |
| `PhysicalJurisdiction` | string | The jurisdiction or state code for the physical address. |
| `PhysicalPostalCode` | string | The postal or ZIP code for the physical address. |
| `PhysicalCountryCode` | string | The ISO 3166-1 alpha-3 country code for the physical address. |
| `PhysicalCounty` | string | The county name for the physical address. |
| `PhysicalCountyCode` | string | The county code for the physical address. |
| `MailingAddress1` | string | The first line of the mailing street address. |
| `MailingAddress2` | string | The second line of the mailing street address. |
| `MailingCity` | string | The city for the mailing address. |
| `MailingJurisdiction` | string | The jurisdiction or state code for the mailing address. |
| `MailingPostalCode` | string | The postal or ZIP code for the mailing address. |
| `MailingCountryCode` | string | The ISO 3166-1 alpha-3 country code for the mailing address. |
| `MailingCounty` | string | The county name for the mailing address. |
| `MailingCountyCode` | string | The county code for the mailing address. |
| `CustomId` | string | The client-defined custom identifier. |
| `ManufacturerCode` | string | The manufacturer code. |
| `ManufacturerJurisdictions` | array | The jurisdiction-specific records associated with this manufacturer. |
| `ManufacturerMappingId` | string | The client-supplied mapping identifier for correlating requests and responses. |

### Avalara.Excise.Common.Contracts.Services.RestManufacturerJurisdiction

Represents manufacturer jurisdiction information for REST services, containing jurisdiction details and status information.

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `MsaStatus` | string | The master settlement agreement (MSA) status. |
| `LicenseNumber` | string | The license number. |
| `ManufacturerCode` | string | The manufacturer code. |
| `Status` | string | The processing status of this record (e.g., Inserted, Updated, Failed). |
| `Message` | string | A human-readable status or result message. |

### Avalara.Excise.Common.Contracts.Services.RestManufacturerImportResultSummary

Manufacturer Import Result Summary

| Property | Type | Description |
|---|---|---|
| `ManufacturerResults` | array | Manufacturer Results |
| `Status` | string | The processing status of this record (for example, Inserted, Updated, or Failed). |
| `NumberProcessed` | integer | Number Processed |
| `NumberInserted` | integer | Number Inserted |
| `NumberUpdated` | integer | Number Updated |
| `NumberFailed` | integer | Number Failed |

### Avalara.Excise.Common.Contracts.Services.RestManufacturerResult

Represents the result of a manufacturer processing operation in REST services, including status and error information.

| Property | Type | Description |
|---|---|---|
| `ManufacturerErrors` | array | Errors encountered while processing this manufacturer. |
| `ManufacturerId` | integer | The unique identifier of the manufacturer. |
| `ManufacturerMappingId` | string | Maps back to the passed in MappingId |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code for the manufacturer jurisdiction. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `MsaStatus` | string | The Master Settlement Agreement (MSA) participation status. |
| `IdType` | string | The type of tax or regulatory identifier. |
| `IdCode` | string | The tax or regulatory identifier value. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `LicenseNumber` | string | The manufacturer license number. |
| `LegalName` | string | The legal business name. |
| `TradeName` | string | The doing-business-as or trade name. |
| `PhysicalAddress1` | string | The first line of the physical street address. |
| `PhysicalAddress2` | string | The second line of the physical street address. |
| `PhysicalCity` | string | The city of the physical address. |
| `PhysicalJurisdiction` | string | The jurisdiction or state code for the physical address. |
| `PhysicalPostalCode` | string | The postal or ZIP code for the physical address. |
| `PhysicalCountryCode` | string | The ISO 3166-1 alpha-3 country code for the physical address. |
| `PhysicalCounty` | string | The county name for the physical address. |
| `PhysicalCountyCode` | string | The county code for the physical address. |
| `MailingAddress1` | string | The first line of the mailing street address. |
| `MailingAddress2` | string | The second line of the mailing street address. |
| `MailingCity` | string | The city of the mailing address. |
| `MailingJurisdiction` | string | The jurisdiction or state code for the mailing address. |
| `MailingPostalCode` | string | The postal or ZIP code for the mailing address. |
| `MailingCountryCode` | string | The ISO 3166-1 alpha-3 country code for the mailing address. |
| `MailingCounty` | string | The county name for the mailing address. |
| `MailingCountyCode` | string | The county code for the mailing address. |
| `CustomId` | string | A client-defined identifier for this record. |
| `ManufacturerCode` | string | The manufacturer code identifier. |
| `Status` | string | Processing outcome of the manufacturer operation (for example Inserted, Updated, or Failed). |
| `Message` | string | Status or informational message for this manufacturer result. |

### Avalara.Excise.Common.Contracts.Services.RestManufacturerError

Represents an error that occurred during import for a manufacturer.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | The sequence position of this error within the import batch. |
| `ErrorCode` | string | The machine-readable error code. |
| `ErrorMessage` | string | The error message describing why the operation failed. |

### Avalara.Excise.Common.Contracts.Services.ProductTobaccoImportRequest

This is the request object for the REST service

| Property | Type | Description |
|---|---|---|
| `TobaccoProducts` | array | Tobacco Products |
| `ImportName` | string | Import Name |
| `UpdateMatchesMode` | string | Update Matches Mode |
| `AssignManufacturers` | boolean | Assign Manufacturers |
| `AssignDefaultManufacturer` | boolean | Assign Default Manufacturer |
| `TerminateImmediate` | boolean | Terminate Immediate |
| `ExactMatchCountryCode` | boolean | Exact Match Country Code |
| `ExactMatchJurisdiction` | boolean | Exact Match Jurisdiction |
| `ExactMatchName` | boolean | Exact Match Name |
| `ExactMatchStateAssignedCode` | boolean | Exact Match State Assigned Code |
| `ExactMatchStyle` | boolean | Exact Match Style |
| `ExactMatchUnitOfMeasure` | boolean | Exact Match Unit of Measure |
| `ExactMatchUnitsPerPackage` | boolean | Exact Match Units Per Package |
| `ExactMatchUpc` | boolean | Exact Match Upc |
| `ExactMatchProductCode` | boolean | Exact Match Product Code |
| `ExactMatchCustomId` | boolean | Exact Match Custom Id |
| `ExactMatchDescription` | boolean | Exact Match Description |
| `ExactMatchModifiedRiskType` | boolean | Exact Match Modified Risk Type |
| `ExactMatchModifiedRiskNumber` | boolean | Exact Match Modified Risk Number |
| `ExactMatchUnitVolume` | boolean | Exact Match Unit Volume |
| `ExactMatchUnitWeight` | boolean | Exact Match Unit Weight |
| `ExactMatchUnitLength` | boolean | Exact Match Unit Length |
| `ExactMatchJurisdictionDescriptionCode` | boolean | Exact Match Jurisdiction Description Code |
| `ExactMatchUnitVolumeUnitOfMeasure` | boolean | Exact Match Unit Volume Unit of Measure |
| `ExactMatchUnitWeightUnitOfMeasure` | boolean | Exact Match Unit Weight Unit of Measure |
| `ExactMatchUnitLengthUnitOfMeasure` | boolean | Exact Match Unit Length Unit of Measure |
| `LoadId` | string | Load Id |
| `ProductTobaccoMatchSku` | boolean | Product Tobacco Match Sku |
| `ExactMatchPackSize` | boolean | Exact Match Pack Size |
| `ProductTobaccoDetermineProductJurisdictions` | boolean | Product Tobacco Determine Product Jurisdictions |
| `ProductTobaccoProductCrossReference` | boolean | Product Tobacco Product Cross Reference |
| `ProductsTobaccoAttributeUpdateMode` | string | Products Tobacco Attribute Update Mode |
| `ProductsTobaccoJurisdictionUpdateMode` | string | Products Tobacco Jurisdiction Update Mode |
| `UpdateMatchesModeManufacturer` | string | Update Matches Mode |
| `ManufacturerJurisdictionUpdateMode` | string | Manufacturer Jurisdiction Update Mode |
| `ExactMatchCountryCodeManufacturer` | boolean | Exact Match Country Code |
| `ExactMatchJurisdictionManufacturer` | boolean | Exact Match Jurisdiction |
| `ExactMatchLegalNameManufacturer` | boolean | Exact Match Legal Name |
| `ExactMatchMsaStatusManufacturer` | boolean | Exact Match Msa Status |
| `ExactMatchIdTypeIdCodeManufacturer` | boolean | Exact Match Id Type Id Code |
| `ExactMatchCustomIdManufacturer` | boolean | Exact Match Custom Id |
| `ExactMatchLicenseNumberManufacturer` | boolean | Exact Match License Number |
| `ExactMatchTradeNameManufacturer` | boolean | Exact Match Trade Name |
| `ExactMatchManufacturerCodeManufacturer` | boolean | Exact Match Manufacturer Code |
| `TerminateNewRecordsManufacturer` | boolean | Terminate New Records |

### Avalara.Excise.Common.Contracts.Services.RestProductTobacco

Represents a tobacco product record for REST services, including identifiers, effective dates, and nested attributes and jurisdictions.

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `Upc` | string | The Universal Product Code (UPC) for the product. |
| `Name` | string | The display name. |
| `ProductCode` | string | The product code identifier. |
| `CustomId` | string | The client's custom identifier for the product. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `LockedDate` | string | The date when the record was locked for editing. |
| `BrandCode` | string | The brand code for the tobacco product. |
| `Style` | string | The product style or variant description. |
| `UnitOfMeasure` | string | The unit of measure for quantity reporting (for example, pack or carton). |
| `UnitsPerPackage` | number | The number of units contained in one package. |
| `Description` | string | The product description. |
| `ModifiedRiskType` | string | The modified-risk tobacco product classification (for example, FDA modified-risk type). |
| `ModifiedRiskNumber` | string | The modified-risk order or reference number associated with the product. |
| `UnitVolume` | number | The volume per sellable unit for the product. |
| `UnitVolumeUnitOfMeasure` | string | The unit of measure for unit volume (for example, milliliters). |
| `UnitWeight` | number | The weight per sellable unit for the product. |
| `UnitWeightUnitOfMeasure` | string | The unit of measure for unit weight (for example, grams). |
| `UnitLength` | number | The length per sellable unit for the product. |
| `UnitLengthUnitOfMeasure` | string | The unit of measure for unit length (for example, millimeters). |
| `JurisdictionDescriptionCode` | string | The jurisdiction-specific product description code used for excise reporting. |
| `Sku` | string | The stock keeping unit (SKU) identifier. |
| `PackSize` | integer | The pack size (for example, count of units per pack). |
| `Manufacturer` | Avalara.Excise.Common.Contracts.Services.RestManufacturer | The manufacturer details when supplied with the product. |
| `ProductTobaccoAttributes` | array | The tobacco product attribute name and value pairs used for excise classification or reporting. |
| `ProductTobaccoJurisdictions` | array | The jurisdiction-specific rows linked to this tobacco product. |
| `ProductTobaccoMappingId` | string | The client-supplied correlation identifier for this product in the import batch. |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoAttribute

Represents tobacco product attributes for REST services, containing attribute names and values.

| Property | Type | Description |
|---|---|---|
| `AttributeName` | string | The name of the tobacco product attribute used for excise classification or reporting. |
| `AttributeValue` | string | The value associated with the attribute name for excise classification or reporting. |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoJurisdiction

Represents jurisdiction-specific tobacco product data for REST services (brand, style, and reporting codes per jurisdiction).

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `ProductCode` | string | The product code identifier. |
| `BrandCode` | string | The brand code for this jurisdiction-specific tobacco product row. |
| `Style` | string | The product style or variant description for this jurisdiction. |
| `JurisdictionDescriptionCode` | string | The jurisdiction-specific product description code used for excise reporting. |
| `ModifiedRiskType` | string | The modified-risk tobacco product classification for this jurisdiction. |
| `ModifiedRiskNumber` | string | The modified-risk order or reference number for this jurisdiction. |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoImportResultSummary

Summarizes the results of a tobacco product import operation, including counts and per-record results.

| Property | Type | Description |
|---|---|---|
| `ProductTobaccoResults` | array | The per-product results from the tobacco product import. |
| `Status` | string | The processing status of the import operation (for example, success or warning). |
| `NumberProcessed` | integer | The total number of records processed during the import. |
| `NumberInserted` | integer | The total number of records inserted during the import. |
| `NumberUpdated` | integer | The total number of records updated during the import. |
| `NumberFailed` | integer | The total number of records that failed during the import. |
| `NumberManufacturerProcessed` | integer | The total number of manufacturer records processed during the import. |
| `NumberManufacturerInserted` | integer | The total number of manufacturer records inserted during the import. |
| `NumberManufacturerUpdated` | integer | The total number of manufacturer records updated during the import. |
| `NumberManufacturerFailed` | integer | The total number of manufacturer records that failed during the import. |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoResult

Rest Product Tobacco Result

| Property | Type | Description |
|---|---|---|
| `Manufacturers` | array | Manufacturer Result |
| `ProductTobaccoAttributes` | Avalara.Excise.Common.Contracts.Services.RestProductTobaccoAttributeResult | Rest Product Tobacco Attribute Result |
| `ProductTobaccoJurisdictions` | Avalara.Excise.Common.Contracts.Services.RestProductTobaccoJurisdictionImportResultSummary | Product Tobacco Jurisdiction Import Result Summary |
| `ProductTobaccoErrors` | array | Product Tobacco Error |
| `ProductTobaccoId` | integer | The unique identifier of the tobacco product. |
| `ProductTobaccoMappingId` | string | Maps back to the passed in MappingId |
| `CustomId` | string | A client-defined identifier for this record. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `Name` | string | The display name. |
| `Code` | string | The short or alternate product code identifier. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ProductCode` | string | The product code identifier. |
| `UnitsPerPackage` | number | The number of units contained in one package. |
| `Upc` | string | The Universal Product Code (UPC). |
| `Style` | string | The product style or category designation. |
| `UnitOfMeasure` | string | The unit of measure for packaged quantity. |
| `Description` | string | A human-readable description. |
| `ModifiedRiskType` | string | The modified-risk tobacco product type designation. |
| `ModifiedRiskNumber` | string | The modified-risk product authorization or reference number. |
| `UnitVolume` | number | The volume of a single unit (for example, per stick or pack). |
| `UnitWeight` | number | The weight of a single unit. |
| `UnitLength` | number | The length of a single unit. |
| `UnitVolumeUnitOfMeasure` | string | The unit of measure for unit volume. |
| `UnitWeightUnitOfMeasure` | string | The unit of measure for unit weight. |
| `UnitLengthUnitOfMeasure` | string | The unit of measure for unit length. |
| `JurisdictionDescriptionCode` | string | The jurisdiction-specific description or category code. |
| `Sku` | string | The stock keeping unit (SKU) identifier. |
| `PackSize` | integer | The number of items in a pack. |
| `Status` | string | The processing status of this record (for example, Inserted, Updated, or Failed). |
| `Message` | string | A human-readable status or detail message for this result. |
| `NumberProductTobaccoAttributesProcessed` | integer | Number of Product Tobacco Attributes Processed |
| `NumberProductTobaccoAttributesInserted` | integer | Number of Product Tobacco Attributes Inserted |
| `NumberProductTobaccoAttributesRemoved` | integer | Number of Product Tobacco Attributes Removed |
| `NumberProductTobaccoAttributesUpdated` | integer | Number of Product Tobacco Attributes Updated |
| `NumberProductTobaccoAttributesFailed` | integer | Number of Product Tobacco Attributes Failed |
| `NumberProductTobaccoJurisdictionsProcessed` | integer | Number of Product Tobacco Jurisdictions Processed |
| `NumberProductTobaccoJurisdictionsInserted` | integer | Number of Product Tobacco Jurisdictions Inserted |
| `NumberProductTobaccoJurisdictionsUpdated` | integer | Number of Product Tobacco Jurisdictions Updated |
| `NumberProductTobaccoJurisdictionsFailed` | integer | Number of Product Tobacco Jurisdictions Failed |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoAttributeResult

Product Tobacco Attribute Results

| Property | Type | Description |
|---|---|---|
| `ProductTobaccoAttributeErrors` | array | Product Tobacco Attribute Error |
| `ProductTobaccoId` | integer | The unique identifier of the tobacco product. |
| `AttributeName` | string | Attribute Name |
| `AttributeValue` | string | Attribute Value |
| `Status` | string | The processing status of this record (for example, Inserted, Updated, or Failed). |
| `Message` | string | A human-readable status or detail message for this result. |
| `NumberProcessed` | integer | Number Processed |
| `NumberInserted` | integer | Number Inserted |
| `NumberRemoved` | integer | Number Removed |
| `NumberUpdated` | integer | Number Updated |
| `NumberFailed` | integer | Number Failed |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoJurisdictionImportResultSummary

Summarizes the results of a tobacco product jurisdiction import operation, including counts and per-record results.

| Property | Type | Description |
|---|---|---|
| `ProductTobaccoJurisdictionResults` | array | The per-jurisdiction results from the tobacco product jurisdiction import. |
| `Status` | string | The processing status of the import operation (for example, success or warning). |
| `NumberProcessed` | integer | The total number of records processed during the import. |
| `NumberInserted` | integer | The total number of records inserted during the import. |
| `NumberUpdated` | integer | The total number of records updated during the import. |
| `NumberFailed` | integer | The total number of records that failed during the import. |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoError

Represents an error that occurred during import for a tobacco product.

| Property | Type | Description |
|---|---|---|
| `SequenceId` | integer | The sequence position of the failed item within the import operation. |
| `ErrorCode` | string | The machine-readable error code for the failure. |
| `ErrorMessage` | string | The error message describing why the operation failed. |

### Avalara.Excise.Common.Contracts.Services.RestProductTobaccoJurisdictionResult

Represents the import result for a tobacco product jurisdiction, including status and any error details.

| Property | Type | Description |
|---|---|---|
| `ProductTobaccoJurisdictionErrors` | array | The errors that occurred for this tobacco product jurisdiction during import. |
| `ProductTobaccoId` | integer | The unique identifier of the parent tobacco product record after processing. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `BrandCode` | string | The brand code for this jurisdiction-specific row. |
| `ProductCode` | string | The product code identifier. |
| `Style` | string | The product style or variant description for this jurisdiction. |
| `ModifiedRiskType` | string | The modified-risk tobacco product classification for this jurisdiction. |
| `ModifiedRiskNumber` | string | The modified-risk order or reference number for this jurisdiction. |
| `JurisdictionDescriptionCode` | string | The jurisdiction-specific product description code used for excise reporting. |
| `Status` | string | The processing status of this record (for example, Inserted, Updated, or Failed). |
| `Message` | string | The human-readable status or result message for this jurisdiction row. |

### Avalara.Excise.Common.Contracts.Services.ScheduleTransactionImportRequest

This is the request object for the REST service

| Property | Type | Description |
|---|---|---|
| `Transactions` | array | Gets or sets the array of schedule transactions to be imported. |
| `LoadId` | string | Gets or sets the load identifier for this import request.
This uniquely identifies the import batch. |
| `OverridePriorityBusinessEntityLegalName` | integer | Gets or sets the override priority for business entity legal name matching. |
| `OverridePriorityBusinessEntityIdTypeCode` | integer | Gets or sets the override priority for business entity ID type code matching. |
| `OverridePriorityBusinessEntityCustomId` | integer | Gets or sets the override priority for business entity custom ID matching. |
| `TotalBatches` | integer | Gets or sets the total number of batches in this import operation. |
| `BatchSize` | integer | Gets or sets the size of each batch in this import operation. |
| `BusinessEntityUpdateMatchesMode` | string | Gets or sets the update match type mode for business entity matching. |
| `TerminateNewBusinessEntities` | boolean | Gets or sets a value indicating whether new business entities should be terminated. |
| `LocationsUpdateMatchesMode` | string | Gets or sets the update match type mode for location matching. |
| `LimitTaxSessionsByEndPeriod` | string | Gets or sets the end period date to limit tax sessions by. |
| `LimitTaxSessionsByCountry` | string | Gets or sets the country code to limit tax sessions by. |
| `LimitTaxSessionsByJurisdiction` | string | Gets or sets the jurisdiction to limit tax sessions by. |
| `LimitTaxSessionsByTaxpayerType` | string | Gets or sets the taxpayer type to limit tax sessions by. |
| `LimitTaxSessionsByTerminalCode` | string | Gets or sets the terminal code to limit tax sessions by. |
| `LimitTaxSessionsByLocationId` | string | Gets or sets the location ID to limit tax sessions by. |
| `ScheduleTransactionDataEntryComplete` | boolean | Gets or sets a value indicating whether schedule transaction data entry is complete. |
| `EnableWorkflowReset` | boolean | Gets or sets a value indicating whether workflow reset is enabled. |
| `TerminateNewLocations` | boolean | Gets or sets a value indicating whether new locations should be terminated. |
| `PrimarySelectionType` | string | Gets or sets the primary selection type for the import operation. |
| `SecondarySelectionType` | string | Gets or sets the secondary selection type for the import operation. |
| `TargetEndPeriod` | string | Gets or sets the target end period date for the import operation. |
| `ApplyProfiles` | boolean | Gets or sets a value indicating whether to apply profiles during import. |
| `CorrectionType` | string | INSERT, UPDATE, or CORRECT |
| `LastBatchSent` | boolean | Gets or sets a value indicating whether this is the last batch being sent. |
| `BatchNumber` | integer | Gets or sets the current batch number in the import sequence. |
| `EmailNotification` | string | Gets or sets the email address for import completion notifications. |
| `EmailNotificationUserId` | string | Gets or sets the user ID associated with email notifications. |
| `EmailNotificationEnabledStepOne` | boolean | Gets or sets a value indicating whether email notification is enabled for step one. |
| `EmailNotificationEnabledStepTwo` | boolean | Gets or sets a value indicating whether email notification is enabled for step two. |
| `EmailNotificationEnabledStepThree` | boolean | Gets or sets a value indicating whether email notification is enabled for step three. |
| `SourceName` | string | Gets or sets the source name for the import operation. |
| `LocationExactMatchCountryCode` | boolean | Gets or sets a value indicating whether to use exact match for location country code. |
| `LocationExactMatchJurisdiction` | boolean | Gets or sets a value indicating whether to use exact match for location jurisdiction. |
| `LocationExactMatchDescription` | boolean | Gets or sets a value indicating whether to use exact match for location description. |
| `LocationExactMatchAddress1` | boolean | Gets or sets a value indicating whether to use exact match for location address line 1. |
| `LocationExactMatchAddress2` | boolean | Gets or sets a value indicating whether to use exact match for location address line 2. |
| `LocationExactMatchCity` | boolean | Gets or sets a value indicating whether to use exact match for location city. |
| `LocationExactMatchPostalCode` | boolean | Gets or sets a value indicating whether to use exact match for location postal code. |
| `LocationExactMatchAlternateJurisdiction` | boolean | Gets or sets a value indicating whether to use exact match for location alternate jurisdiction. |
| `LocationExactMatchAlternateFacilityNumber` | boolean | Gets or sets a value indicating whether to use exact match for location alternate facility number. |
| `LocationExactMatchAirportCode` | boolean | Gets or sets a value indicating whether to use exact match for location airport code. |
| `LocationExactMatchStateAssignedCode` | boolean | Gets or sets a value indicating whether to use exact match for location state assigned code. |
| `LocationExactMatchSiteCode` | boolean | Gets or sets a value indicating whether to use exact match for location site code. |
| `LocationExactMatchSpecialJurisdiction` | boolean | Gets or sets a value indicating whether to use exact match for location special jurisdiction. |
| `LocationExactMatchCounty` | boolean | Gets or sets a value indicating whether to use exact match for location county. |
| `LocationExactMatchCountyCode` | boolean | Gets or sets a value indicating whether to use exact match for location county code. |
| `LocationExactMatchDepNumber` | boolean | Gets or sets a value indicating whether to use exact match for location DEP number. |
| `LocationExactMatchLocationType` | boolean | Gets or sets a value indicating whether to use exact match for location type. |
| `LocationExactMatchOutsideCityLimit` | boolean | Gets or sets a value indicating whether to use exact match for location outside city limit indicator. |
| `ProductTobaccoMatchCountryCode` | boolean | Gets or sets a value indicating whether to match product tobacco by country code. |
| `ProductTobaccoMatchJurisdiction` | boolean | Gets or sets a value indicating whether to match product tobacco by jurisdiction. |
| `ProductTobaccoMatchName` | boolean | Gets or sets a value indicating whether to match product tobacco by name. |
| `ProductTobaccoMatchStateAssignedCode` | boolean | Gets or sets a value indicating whether to match product tobacco by state assigned code. |
| `ProductTobaccoMatchStyle` | boolean | Gets or sets a value indicating whether to match product tobacco by style. |
| `ProductTobaccoMatchUnitOfMeasure` | boolean | Gets or sets a value indicating whether to match product tobacco by unit of measure. |
| `ProductTobaccoMatchUnitsPerPackage` | boolean | Gets or sets a value indicating whether to match product tobacco by units per package. |
| `ProductTobaccoMatchUpc` | boolean | Gets or sets a value indicating whether to match product tobacco by UPC. |
| `ProductTobaccoMatchProductCode` | boolean | Gets or sets a value indicating whether to match product tobacco by product code. |
| `ProductTobaccoMatchCustomId` | boolean | Gets or sets a value indicating whether to match product tobacco by custom ID. |
| `ProductTobaccoMatchDescription` | boolean | Gets or sets a value indicating whether to match product tobacco by description. |
| `ProductTobaccoMatchModifiedRisk` | boolean | Gets or sets a value indicating whether to match product tobacco by modified risk type. |
| `ProductTobaccoMatchModifiedRiskNumber` | boolean | Gets or sets a value indicating whether to match product tobacco by modified risk number. |
| `ProductTobaccoMatchUnitVolume` | boolean | Gets or sets a value indicating whether to match product tobacco by unit volume. |
| `ProductTobaccoMatchUnitVolumeUnitOfMeasure` | boolean | Gets or sets a value indicating whether to match product tobacco by unit volume unit of measure. |
| `ProductTobaccoMatchUnitWeight` | boolean | Gets or sets a value indicating whether to match product tobacco by unit weight. |
| `ProductTobaccoMatchUnitWeightUnitOfMeasure` | boolean | Gets or sets a value indicating whether to match product tobacco by unit weight unit of measure. |
| `ProductTobaccoMatchUnitLength` | boolean | Gets or sets a value indicating whether to match product tobacco by unit length. |
| `ProductTobaccoMatchUnitLengthUnitOfMeasure` | boolean | Gets or sets a value indicating whether to match product tobacco by unit length unit of measure. |
| `ProductTobaccoMatchJurisdictionDescriptionCode` | boolean | Gets or sets a value indicating whether to match product tobacco by jurisdiction description code. |
| `ProductTobaccoMatchSku` | boolean | Gets or sets a value indicating whether to match product tobacco by SKU. |
| `ProductTobaccoMatchPackSize` | boolean | Gets or sets a value indicating whether to match product tobacco by pack size. |
| `ProductTobaccoTerminateNewRecords` | boolean | Gets or sets a value indicating whether to terminate new product tobacco records. |
| `ProductTobaccoAssignManufacturers` | boolean | Gets or sets a value indicating whether to assign manufacturers to product tobacco records. |
| `ProductTobaccoAssignDefaultManufacturer` | boolean | Gets or sets a value indicating whether to assign default manufacturer to product tobacco records. |
| `ProductTobaccoDetermineProductJurisdictions` | boolean | Gets or sets a value indicating whether to determine product jurisdictions for product tobacco records. |
| `ProductTobaccoProductCrossReference` | boolean | Gets or sets a value indicating whether to use product cross reference for product tobacco records. |
| `ProductsTobaccoUpdateMatchesMode` | string | Gets or sets the update match type mode for product tobacco matching. |
| `ProductsTobaccoAttributeUpdateMode` | string | Gets or sets the update type mode for product tobacco attributes. |
| `ProductsTobaccoJurisdictionUpdateMode` | string | Gets or sets the update type mode for product tobacco jurisdictions. |
| `ItemCodeUpdateMatchesMode` | string | Gets or sets the update match type mode for item code matching. |
| `ManufacturerMatchCountryCode` | boolean | Gets or sets a value indicating whether to match manufacturers by country code. |
| `ManufacturerMatchJurisdiction` | boolean | Gets or sets a value indicating whether to match manufacturers by jurisdiction. |
| `ManufacturerMatchLegalName` | boolean | Gets or sets a value indicating whether to match manufacturers by legal name. |
| `ManufacturerMatchMsaStatus` | boolean | Gets or sets a value indicating whether to match manufacturers by MSA status. |
| `ManufacturerMatchIdTypeIdCode` | boolean | Gets or sets a value indicating whether to match manufacturers by ID type code. |
| `ManufacturerMatchCustomId` | boolean | Gets or sets a value indicating whether to match manufacturers by custom ID. |
| `ManufacturerMatchLicenseNumber` | boolean | Gets or sets a value indicating whether to match manufacturers by license number. |
| `ManufacturerMatchTradeName` | boolean | Gets or sets a value indicating whether to match manufacturers by trade name. |
| `ManufacturerMatchManufacturerCode` | boolean | Gets or sets a value indicating whether to match manufacturers by manufacturer code. |
| `ManufacturerTerminateNewRecords` | boolean | Gets or sets a value indicating whether to terminate new manufacturer records. |
| `ManufacturerUpdateMatchesMode` | string | Gets or sets the update match type mode for manufacturer matching. |
| `ManufacturerJurisdictionUpdateMode` | string | Gets or sets the update type mode for manufacturer jurisdictions. |
| `UserForcedCancel` | boolean | Gets or sets a value indicating whether the user forced cancellation of the import operation. |
| `AutomaticBackup` | boolean | Gets or sets a value indicating whether to perform automatic backup. |
| `CreateAllAccountTypes` | boolean | Gets or sets a value indicating whether to create all account types. |
| `TransactionsSent` | integer | Gets or sets the number of transactions sent in this batch. |
| `ProcessDescription` | string | Gets or sets the description of the import process. |
| `ProcessName` | string | Gets or sets the name of the import process. |
| `StiVersionNumber` | string | Gets or sets the schedule transaction importer version number. |

### Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction

Represents a schedule transaction for excise reporting import, including session context, parties, locations, product details, and line-level taxes.
Any changes to this structure will require a newly versioned class.

| Property | Type | Description |
|---|---|---|
| `SupplementalFields` | array | Additional field names supplied with the transaction beyond the standard properties. |
| `SupplementalValues` | array | Values corresponding to {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.SupplementalFields}, in the same order. |
| `TaxSessionCountryCode` | string | The ISO 3166-1 alpha-3 country code for the tax session. |
| `TaxSessionJurisdiction` | string | The jurisdiction or state code for the tax session. |
| `TaxSessionTaxpayerType` | string | The taxpayer type for the tax session. |
| `TaxSessionTerminalCode` | string | The terminal code for the tax session. |
| `TaxSessionLocationId` | integer | The location identifier for the tax session. |
| `ScheduleCode` | string | The reporting schedule code. |
| `ScheduleType` | string | The schedule type classification. |
| `ProductCode` | string | The product code identifier. |
| `ModeCode` | string | The transport or transaction mode code. |
| `BillOfLading` | string | The bill of lading number. |
| `BillOfLadingDate` | string | The bill of lading date. |
| `InvoiceNumber` | string | The invoice number. |
| `InvoiceDate` | string | The invoice date. |
| `Origin` | Avalara.Excise.Common.Contracts.Services.RestLocation | The origin location for the movement or transaction. |
| `Destination` | Avalara.Excise.Common.Contracts.Services.RestLocation | The destination location for the movement or transaction. |
| `DiversionDestination` | Avalara.Excise.Common.Contracts.Services.RestLocation | The diversion destination location, when the shipment is diverted. |
| `PointOfOrderAcceptance` | Avalara.Excise.Common.Contracts.Services.RestLocation | The location where the order was accepted. |
| `PointOfOrderOrigin` | Avalara.Excise.Common.Contracts.Services.RestLocation | The location where the order originated. |
| `DiversionNumber` | string | The diversion reference number. |
| `NetUnits` | number | The net quantity in the stated unit of measure. |
| `GrossUnits` | number | The gross quantity in the stated unit of measure. |
| `BilledUnits` | number | The billed quantity in the stated unit of measure. |
| `UnitOfMeasure` | string | The unit of measure for quantity fields. |
| `Buyer` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The buyer business entity on the transaction. |
| `Seller` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The seller business entity on the transaction. |
| `Consignor` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The consignor business entity on the transaction. |
| `Carrier` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The carrier business entity on the transaction. |
| `ExchangePosition` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The exchange position business entity, when applicable. |
| `PositionHolder` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The position holder business entity, when applicable. |
| `Importer` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The importer business entity on the transaction. |
| `MiddleMan` | Avalara.Excise.Common.Contracts.Services.RestBusinessEntity | The middleman or intermediary business entity on the transaction. |
| `FuelUseCode` | string | The fuel use code for the product or movement. |
| `ProductSubsetCode` | string | The product subset code for more specific classification. |
| `UnitPrice` | number | The unit price for the product line. |
| `TaxCollected` | number | The tax amount collected on the line. |
| `Currency` | string | The currency code for monetary amounts. |
| `ExchangeInd` | string | Whether the transaction is an exchange transaction. |
| `SourceSystemId` | string | The identifier of the record in the source system. |
| `LoadId` | string | The unique identifier grouping this line with its import batch. |
| `SequenceId` | string | The sequence identifier for ordering lines within a load. |
| `OriginId` | integer | The origin location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Origin} object. |
| `DestinationId` | integer | The destination location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Destination} object. |
| `DiversionDestinationId` | integer | The diversion destination location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.DiversionDestination} object. |
| `PointOfOrderAcceptanceId` | integer | The point-of-order-acceptance location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.PointOfOrderAcceptance} object. |
| `PointOfOrderOriginId` | integer | The point-of-order-origin location identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.PointOfOrderOrigin} object. |
| `BuyerId` | integer | The buyer business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Buyer} object. |
| `SellerId` | integer | The seller business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Seller} object. |
| `ConsignorId` | integer | The consignor business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Consignor} object. |
| `CarrierId` | integer | The carrier business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Carrier} object. |
| `ExchangePositionId` | integer | The exchange position business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.ExchangePosition} object. |
| `PositionHolderId` | integer | The position holder business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.PositionHolder} object. |
| `ImporterId` | integer | The importer business entity identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Importer} object. |
| `ActivityDate` | string | The business activity date for the transaction. |
| `AllowanceCode` | string | The allowance or credit code applied to the line. |
| `BaseProduct` | string | The base product code for blend reporting. |
| `BaseProductUnits` | number | The quantity of the base blend component. |
| `BlendProduct1` | string | The first blend component product code. |
| `BlendProduct1Units` | number | The quantity of the first blend component. |
| `BlendProduct2` | string | The second blend component product code. |
| `BlendProduct2Units` | number | The quantity of the second blend component. |
| `BlendProduct3` | string | The third blend component product code. |
| `BlendProduct3Units` | number | The quantity of the third blend component. |
| `BlendToProductCode` | string | The product code of the blend result or target product. |
| `CustomId` | string | A custom identifier for the line or shipment. |
| `ExemptionType` | string | The exemption category or type, when the line is exempt or partially exempt. |
| `PaymentDate` | string | The payment date associated with the transaction. |
| `PurchaseDate` | string | The purchase date associated with the transaction. |
| `TitleTransfer` | string | Indicates how or where title transferred for the product. |
| `SystemOfRecord` | string | The system or application that is the authoritative source for this data. |
| `FilingEntity` | string | The entity responsible for filing or reporting this transaction. |
| `SystemOfRecordProductCode` | string | The product code as recorded in the system of record. |
| `StampAttribute` | string | The stamp or fiscal attribute associated with the product line. |
| `ProductTobacco` | Avalara.Excise.Common.Contracts.Services.RestProductTobacco | Tobacco-specific product attributes when the line is a tobacco product. |
| `ProductTobaccoId` | integer | The identifier linking to tobacco product detail when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.ProductTobacco} object. |
| `Manufacturer` | Avalara.Excise.Common.Contracts.Services.RestManufacturer | The manufacturer associated with the product line. |
| `ManufacturerId` | integer | The manufacturer identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.Manufacturer} object. |
| `DocumentType` | string | The type of supporting document for the transaction. |
| `ItemCode` | Avalara.Excise.Common.Contracts.Services.RestItemCode | The item code reference for the product line. |
| `ItemCodeId` | integer | The item code identifier when not using the nested {Avalara.Excise.Common.Contracts.Services.RestScheduleTransaction.ItemCode} object. |
| `SalesAmount` | number | The sales amount for the line. |
| `TranId` | integer | The internal transaction identifier after persistence. |
| `TransactionLine` | integer | The line number of the transaction within the schedule or import batch. |
| `Taxes` | array | The tax breakdown lines applied to this schedule transaction. |

### Avalara.Excise.Common.Contracts.Services.RestScheduleTransactionTax

Represents tax jurisdiction and rate classification for a single line of a schedule transaction.

| Property | Type | Description |
|---|---|---|
| `TransactionLine` | integer | The line number on the parent transaction this tax row applies to. |
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `LocalJurisdiction` | string | The local or sub-jurisdiction code when tax applies below the state level. |
| `ProductCategory` | number | The product category this tax row applies to. |
| `TaxingLevel` | string | The taxing level (for example, state, county, or city). |
| `TaxType` | string | The type of tax applied on this line. |
| `RateType` | string | The rate type classification. |
| `RateSubtype` | string | The rate subtype classification. |
| `TaxExemptionInd` | string | Whether the line is treated as tax-exempt for this jurisdiction and rate. |

### Avalara.Excise.Common.Contracts.Services.RestRate

Represents an excise tax rate and its applicability (jurisdiction, product category, thresholds, and metadata) for REST APIs.

| Property | Type | Description |
|---|---|---|
| `CountryCode` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `LocalJurisdiction` | string | The local or sub-jurisdiction code when tax applies below the state level. |
| `MasterCompanyId` | integer | The unique identifier of the master company that owns this record. |
| `ProductCategory` | number | The product category this rate applies to. |
| `TaxingLevel` | string | The taxing level (for example, state, county, or city). |
| `TaxType` | string | The type of tax (for example, excise category or levy type). |
| `RateType` | string | The rate type classification. |
| `RateSubtype` | string | The rate subtype classification. |
| `EffectiveDate` | string | The date when the record becomes effective. |
| `ObsoleteDate` | string | The date when the record becomes obsolete. |
| `TaxRate` | number | The numeric tax rate. |
| `CalculationTypeInd` | string | The indicator for how the tax amount is calculated. |
| `MaximumUnits` | number | The maximum unit quantity to which this rate applies, if limited. |
| `MaximumCurrencyAmount` | number | The maximum currency amount to which this rate applies, if limited. |
| `MinimumUnits` | number | The minimum unit quantity to which this rate applies, if a floor applies. |
| `MinimumCurrencyAmount` | number | The minimum currency amount to which this rate applies, if a floor applies. |
| `Description` | string | A human-readable description of the rate. |
| `UnitOfMeasure` | string | The unit of measure for quantity-based application of the rate. |
| `Currency` | string | The currency code for monetary thresholds and amounts. |
| `CreatedDate` | string | The date and time when the rate record was created. |
| `UpdatedDate` | string | The date and time when the rate record was last updated. |
| `StateAssignedCode` | string | The code assigned by the jurisdiction for this rate or reporting line. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionCreateRequest

Request body for POST /api/v1/TaxSessions/Create.

| Property | Type | Description |
|---|---|---|
| `Country` | string | Country associated with the tax return. |
| `Jurisdiction` | string | Jurisdiction associated with the tax return. |
| `TaxpayerType` | string | TaxpayerType code associated with the tax return. |
| `TerminalCode` | string | TerminalCode associated with the tax return (supported for specific returns only). |
| `LocationID` | integer | LocationID associated with the tax return (supported for specific returns only). |
| `StartDate` | string | First day of the reporting period for the tax session. |
| `EndDate` | string | Last day of the reporting period. Required for variable-length frequencies
(VariableLength, VariableLengthCalendarYear, VariableCalendarMonth, VariableNinetyDays, VariableDueDates, OnDemand).
Ignored for fixed frequencies (Monthly, Quarterly, Annually, etc.) where the system computes EndDate automatically. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionResponse

Response returned by Tax Session Create, GetByHeader, and Amend endpoints.

| Property | Type | Description |
|---|---|---|
| `CompanyName` | string | The company name. |
| `CompanyId` | integer | The company context under which the session was created. |
| `HeaderId` | integer | The unique header identifier. |
| `Country` | string | The ISO 3166-1 alpha-3 country code. |
| `Jurisdiction` | string | The jurisdiction or state code. |
| `TaxpayerType` | string | The taxpayer type code. |
| `TaxpayerDescription` | string | The human-readable taxpayer type description. |
| `TerminalCode` | string | The terminal or facility code. |
| `TrackingNumber` | string | The tracking number. |
| `LocationID` | integer | The location identifier. |
| `ReturnCode` | string | The return code. |
| `ReturnEffectiveDate` | string | The effective date used for determining applicable return rules and rates. |
| `StartDate` | string | The first day of the reporting period. |
| `Sequence` | integer | The sequence number (0 = original, 1+ = amendments). |
| `EndDate` | string | The last day of the reporting period. |
| `DueDate` | string | The due date for filing the return. |
| `FiledDate` | string | The date the return was filed, or null if not yet filed. |
| `PurgedDate` | string | The date the session was purged, or null if not purged. |
| `CriticalScheduleErrors` | integer | The count of critical schedule-level errors. |
| `ReturnGenerationNeeded` | boolean | Whether the return needs to be regenerated. |
| `ReturnStatus` | string | The calculation status of the return. |
| `FrequencyType` | string | The filing frequency description (e.g. Monthly, Quarterly, Annual). |
| `FrequencyTypeInd` | string | The filing frequency indicator character. |
| `SessionSourceInd` | string | The session source indicator character. |
| `SessionSource` | string | The human-readable session source description. |
| `SessionLocked` | boolean | Whether the session is locked from editing. |
| `PurgeExcludeInd` | boolean | The purge-exclude indicator. |
| `PreventArchiveandPurge` | boolean | Whether archive and purge is prevented. |
| `ReturnPdfSegmentCount` | integer | The number of PDF segments generated for the return. |
| `GLReconGenerationNeeded` | boolean | Whether GL reconciliation data needs to be generated. |
| `LocationCountry` | string | The ISO 3166-1 alpha-3 country code for the associated location. |
| `LocationJurisdiction` | string | The jurisdiction or state code for the associated location. |
| `LocationCounty` | string | The county name for the associated location. |
| `LocationCountyCode` | string | The county code for the associated location. |
| `LocationCity` | string | The city name for the associated location. |
| `LocationTerminalCode` | string | The terminal code associated with the location. |
| `LocationDescription` | string | A human-readable description of the associated location. |
| `LocationCustomIdCode` | string | A client-defined identifier for the associated location. |
| `LocationAddressLine1` | string | The first line of the street address for the associated location. |
| `LocationAddressLine2` | string | The second line of the street address for the associated location. |
| `LocationPostalCode` | string | The postal or ZIP code for the associated location. |
| `LocationAirportCode` | string | The airport code for the associated location, if applicable. |
| `LocationAlternateJurisdiction` | string | An alternate jurisdiction designation for the associated location, when applicable. |
| `FiledBy` | string | The user who filed the return. |
| `PreparedBy` | string | The user who prepared the return. |
| `ReviewedBy` | string | The user who reviewed the return. |
| `ApprovedBy` | string | The user who approved the return. |
| `LastGeneratedDate` | string | The date the return was last generated. |
| `PostedDate` | string | The date the return was posted to GL or downstream systems. |
| `WorkflowTask` | string | The current workflow task code. |
| `WorkflowTaskDescription` | string | The human-readable description of the current workflow task. |
| `WorkflowName` | string | The assigned workflow name. |
| `TotalTax` | number | The total calculated tax amount for the return. |
| `CollectionAllowance` | number | The collection allowance amount credited on the return. |
| `TotalAmountDue` | number | The total amount due after taxes and allowances. |
| `TaxpayerGroup` | string | The taxpayer group classification. |
| `LicenseNumber` | string | The license or registration number. |
| `SubmissionType` | string | The submission type indicator character. |
| `SubmissionTypeDisplay` | string | The human-readable display name for the submission type. |
| `ThresholdAmount` | number | The amount-due threshold for the return. |
| `ReturnCalculationDate` | string | The date the return calculation was last performed. |
| `LastDataFileUploadDate` | string | The date of the last data file upload. |
| `LasteFileUploadDate` | string | The date of the last eFile upload. |
| `IncludeSchedules` | boolean | Whether schedules are included in the return. |
| `CalculationViewInd` | string | The calculation view description. |
| `BackEndInd` | boolean | Whether this is a back-end session. |
| `AmmendmentType` | string | The amendment type (ORIGINAL or AMENDED). |
| `EFileHeaderId` | integer | The associated eFile header identifier, if an eFile has been created. |
| `CreatedBy` | string | The user who created the record. |
| `CreatedDate` | string | The date and time the record was created. |
| `UpdatedBy` | string | The user who last updated the record. |
| `UpdatedDate` | string | The date and time the record was last updated. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionFieldsResponse

Response returned by the Tax Sessions Fields endpoint, containing all available
tax session field names and their data types. Also provides shared helper methods
for parsing and validating field name parameters.

| Property | Type | Description |
|---|---|---|
| `Data` | array | The list of available tax session fields and their data types. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionFieldDefinition

A single field definition describing a tax session property name and its data type,
returned by the Tax Sessions Fields endpoint.

| Property | Type | Description |
|---|---|---|
| `FieldName` | string | The field name as it appears in the tax session response object. |
| `DataType` | string | The data type of the field (String, Integer, DateTime, Boolean, Currency, Numeric0, Numeric2). |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionUpdateSettingsRequest

Request body for PUT /api/v1/TaxSessions/UpdateSettings.

| Property | Type | Description |
|---|---|---|
| `IncludeSchedules` | boolean | Whether schedule pages should be included in the generated PDF. |
| `CalculationViewInd` | string | Calculation view: C=Current, D=Delta, N=Consolidated, O=Overall. Only updatable for Sequence > 0. |
| `SessionLocked` | boolean | Whether the tax session is locked from regeneration and changes. |
| `PreventArchiveAndPurge` | boolean | Whether the tax session is excluded from archive and purge. |
| `PreparedBy` | string | User name of preparer. |
| `SubmissionType` | string | Submission type: blank, Paper, eFile, or Web. |
| `ReviewedBy` | string | User name of reviewer. |
| `ApprovedBy` | string | User name of approver. |
| `TaxpayerGroup` | string | Group associated with tax session (TAXPAYER_GROUP_TYPE common code). |
| `DueDate` | string | Date the tax session is due. |
| `BackEndInd` | boolean | Whether tax session is owned by a back-end user. Only updatable by back-end users. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionUpdateSettingsResponse

Response returned by the Tax Sessions UpdateSettings endpoint, echoing the settings
that were applied.

| Property | Type | Description |
|---|---|---|
| `IncludeSchedules` | boolean | Whether schedules are included in the return. |
| `CalculationViewInd` | string | The calculation view indicator (C=Current, D=Delta, N=Consolidated, O=Overall). |
| `SessionLocked` | boolean | Whether the session is locked from editing. |
| `PreventArchiveandPurge` | boolean | Whether archive and purge is prevented. |
| `PreparedBy` | string | The user who prepared the return. |
| `SubmissionType` | string | The submission type (e.g. Original, Amended). |
| `ReviewedBy` | string | The user who reviewed the return. |
| `ApprovedBy` | string | The user who approved the return. |
| `TaxpayerGroup` | string | The taxpayer group classification. |
| `DueDate` | string | The due date for filing the return. |
| `BackEndInd` | boolean | Whether this is a back-end session. |

### Avalara.Excise.Common.Contracts.Services.RestReturnErrorsResponse

Response returned by Tax Sessions ReturnErrors and eFiles GetErrors endpoints.

| Property | Type | Description |
|---|---|---|
| `Data` | array | The list of return-level or eFile-level errors. |

### Avalara.Excise.Common.Contracts.Services.RestReturnError

A single return-level or eFile-level error entry.

| Property | Type | Description |
|---|---|---|
| `ErrorLevelInd` | string | The severity of the error (for example Error, Warning, or Informational). |
| `Message` | string | A status or informational message describing the error. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionUpdateManualFieldsRequest

Request body for PUT /api/v1/TaxSessions/UpdateManualFields.

| Property | Type | Description |
|---|---|---|
| `ManualFields` | object | Dictionary of manual field names to their values.
Field names and types are defined by the GetManualFieldDefinitions API. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionUpdateManualFieldsResponse

Response returned by the Tax Sessions UpdateManualFields endpoint.

| Property | Type | Description |
|---|---|---|
| `HeaderId` | integer | The unique header identifier. |
| `Sequence` | integer | The sequence number that was used for the update. |
| `UpdatedFields` | array | The list of field names that were updated. Empty when validateOnly is true. |
| `Errors` | array | Validation errors encountered during the update. |

### Avalara.Excise.Common.Contracts.Services.RestTaxSessionTransactionValidationErrorsResponse

Response returned by the Tax Sessions TransactionValidationErrors endpoint,
containing grouped transaction-level validation errors.

| Property | Type | Description |
|---|---|---|
| `HeaderId` | integer | The unique header identifier. |
| `Sequence` | number | The sequence number that was queried. |
| `Errors` | array | Grouped transaction validation errors. |

### Avalara.Excise.Common.Contracts.Services.RestTransactionValidationErrorItem

A grouped transaction validation error for a tax session.
Each item represents a unique combination of rule, error level, and schedule code,
with a count of affected transactions.

| Property | Type | Description |
|---|---|---|
| `RuleId` | integer | Validation rule identifier. |
| `ErrorLevelInd` | string | Error level indicator: C=Critical, W=Warning, I=Informational. |
| `ScheduleCode` | string | Schedule code associated with this error group. |
| `ErrorMessage` | string | Error message describing the validation failure. |
| `TransactionCount` | integer | Number of transactions affected by this error. |

### Avalara.Excise.Common.Contracts.Services.PingResponse

Represents the response from a ping operation to verify service connectivity and authentication status.
This class is used to check if the service is available and if the current user is properly authenticated.

| Property | Type | Description |
|---|---|---|
| `version` | string | Gets or sets the version of the service that responded to the ping request.
This property indicates which version of the service API is currently active. |
| `authenticated` | boolean | Gets or sets a boolean value indicating whether the current user is authenticated.
True if the user has valid authentication credentials, false otherwise. |
| `authenticatedUserName` | string | Gets or sets the username of the authenticated user.
This property contains the username of the currently authenticated user,
or null/empty if the user is not authenticated. |

### Avalara.Excise.Website.Api.v1.MasterCompanyDetails

Retrieves the master company information

| Property | Type | Description |
|---|---|---|
| `MasterCompanyId` | integer | Master company ID |
| `Name` | string | Master company name |
| `IsDeployed` | boolean | If the master company is deployed |
| `IsActive` | boolean | If the master company is active |
| `HasReturnsExcise` | boolean | Is returns excise enabled |
| `HasAvaTaxExcise` | boolean | Is AvaTax excise enabled |