# TaxSessionsPublicController_UpdateSettings

Updates editable attributes of an existing tax session.

`PUT /api/v1/TaxSessions/UpdateSettings`

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

Source: https://developer.avalara.com/products/excise/api/methods/Tax%20Sessions/TaxSessionsPublicController_UpdateSettings/

## Description

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

## Request Body

**Schema:** `Avalara.Excise.Common.Contracts.Services.RestTaxSessionUpdateSettingsRequest`

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

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

## Responses

| Status | Description | Schema |
|---|---|---|
| 200 | Returns the updated field values. | `Avalara.Excise.Common.Contracts.Services.RestTaxSessionUpdateSettingsResponse` |
| 400 | The request is invalid, the session is filed/locked, or a validation rule failed. |  |
| 401 | Authentication credentials are incorrect. |  |

### 200 Response: `Avalara.Excise.Common.Contracts.Services.RestTaxSessionUpdateSettingsResponse`

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

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

## Example Request

```bash
curl -X PUT "https://excise.avalara.com/api/v1/TaxSessions/UpdateSettings" \
  -H "Authorization: Basic <credentials>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
  "IncludeSchedules": false,
  "CalculationViewInd": "string",
  "SessionLocked": false,
  "PreventArchiveAndPurge": false,
  "PreparedBy": "string",
  "SubmissionType": "string",
  "ReviewedBy": "string",
  "ApprovedBy": "string",
  "TaxpayerGroup": "string",
  "DueDate": "2026-05-22T04:06:19.4406025Z",
  "BackEndInd": false
}'
```