# Chapter 3.1 - Commit Request

Source: https://developer.avalara.com/products/communications/integration-guides/dev-guide_rest_v2/commit-uncommit/commit-request/

-   [Previous](/communications/dev-guide_rest_v2/commit-uncommit/)
-   [Next Chapter](/communications/dev-guide_rest_v2/customizing-transactions/)

Use these methods to commit and uncommit Document Codes:

-   [Commit API](#endpoint)
-   [Commit flag](/communications/dev-guide_rest_v2/customizing-transactions/sample-transactions/commit/) (`cmmt`) in the [invoice](/communications/dev-guide_rest_v2/reference/invoice/)

### Commit Endpoint

Endpoint

Method

Description

Request

Response

`/api/v2/afc/commit`

`POST`

Commits and Uncommits transactions. See [Commit/Uncommit](/communications/dev-guide_rest_v2/commit-uncommit/) for more information.

[Commit Request](/communications/dev-guide_rest_v2/reference/commit-request/)

[Commit Response](/communications/dev-guide_rest_v2/reference/commit-response/)

### The Commit Request

The [Commit request](/communications/dev-guide_rest_v2/reference/commit-request/) is used to change the Commit flag (`cmmt`) for a given Document Code (`doc`). Let’s send a simple `Commit` call using [Postman](https://www.getpostman.com) and inspect the results.

### Headers

Add these [mandatory headers](/communications/dev-guide_rest_v2/getting-started/authentication/) to your request:

-   `Authorization` using basic HTTP authentication
-   `client_id`
-   `Content-Type: application/json`

Include the `client_profile_id` if you are using a [client profile](/communications/dev-guide_rest_v2/customizing-transactions/client-profiles/).

#### Postman Authorization Example

![](/public/images/comms/dev-guide_rest_v2/postman_authorization_commit.png)

#### Postman Headers Example

![](/public/images/comms/dev-guide_rest_v2/postman_headers_commit.png)

### Body

For the body of the `POST` request, copy and paste this example:

```json
{ "doc": "DocumentCode12345", "cmmt": true, "opt": [ { "key": 1, "val": "Optional value" } ]}
```

#### What are we sending?

1.  Document Code (`doc`) "DocumentCode12345"
2.  A request to commit Document Code "DocumentCode12345" by setting the Commit flag (`cmmt`) to `true`

-   `true` commits all transactions with Document Code (`doc`) – “DocumentCode12345” in this example
-   `false` uncommits all transactions with Document Code (`doc`)

4.  Optional information about the [Commit request](/communications/dev-guide_rest_v2/reference/commit-request/) using the [Key Value Pair](/communications/dev-guide_rest_v2/reference/key-value-pair/) (`opt`) object

### Response

The [Commit response](/communications/dev-guide_rest_v2/reference/commit-response/) contains a confirmation of success or failure:

```json
{ "ok": true}
```

-   `true` indicates that the Document Code (`doc`) has been committed or uncommitted successfully (depending on the value of the Commit flag (`cmmt`))
-   `false` indicates an error - details are contained in the [Error response](/communications/dev-guide_rest_v2/reference/error-response/) object

-   [Previous](/communications/dev-guide_rest_v2/commit-uncommit/)
-   [Next Chapter](/communications/dev-guide_rest_v2/customizing-transactions/)