Avalara Developer Network Developer communications

Chapter 3 - Commit/Uncommit

The process to commit transactions is optional and used to identify single or groups of transactions that should be included in the Compliance Reports for remittance to the Department of Revenue (DoR). This process is often used when not all taxes being calculated are considered final for compliance reporting. When a transaction is considered final, a commit can be sent to finalize the document code associated to the transaction. This also allows users to commit an entire invoice by committing the document code instead of calculating the taxes again when the transaction(s) is determined to be final.

A transaction can be committed at any time as long as there is a document code associated to it. However, be aware that committing or uncommiting a document code commits/uncommits all transactions with the specified Document Code (doc).

Commit/Uncommit Process

REST v2 provides the ability to commit or uncommit transactions and only include the committed transactions within compliance reports. The default action is uncommitted.

At any time during the reporting cycle, you may create new transactions and populate the DocumentCode (doc) with a unique identifier in order to group transactions. For example, an invoice number would be a typical value to enter as the DocumentCode. In addition to DocumentCode, the Commit (cmmt) flag is available to identify transactions to include in, or exclude from, the compliance report produced in each reporting cycle.

Only committed transactions appear in the compliance report. Transactions tied to a DocumentCode with a Commit flag set to false are excluded from the compliance report at the end of the reporting cycle.

It is not necessary to set the Commit flag immediately on a transaction. The Commit flag may be set or unset using the Commit API.

Note

The Commit flag may only be changed prior to the end of the reporting cycle. After the reporting cycle, all DocumentCodes with Commit flags set to true are locked and cannot be modified once the compliance report is generated. You may, however, commit previously uncommitted DocumentCodes via the Commit API. To request an updated compliance report, please email CommunicationSupport@avalara.com.