Commit a transaction

Element type: Required

Enpoints/models used: Invoice, Commit

Your integration must provide a method for specifying whether an invoice should be committed as soon as it is processed. This is done using one of the following methods:

Set thecmmt field totrue in the document's Invoice model. This value defaults tofalse. See example 1 below.
Run the Commit endpoint and set thecmmt field totrue. See example 2 below.

Important: Thecmmt flag in a CalculateTaxes request is a "use-once" feature that establishes the state of ALL the transactions for particular document on its first call in a particular reporting month. Even if you try to set thecmmt flag to something else in the CalculateTaxes request, the commit state will not change. Refer to the When to commit topic for more information and examples.

Example 1

"inv": [
  {
    "doc": "StreamingContent1", 
    "cmmt": false, 
    "cust": 0, 
    "date": "2021-01-01T12:00:00Z",
    "invm": true,
    "dtl": true,
    "summ": true,
    "acct": "Broadcaster", 
    "custref": "Customer1234", 
    "invn": "Invoice1234", 
    "bcyc": "202010", 
    "bpd": { 
        "month": "10",
        "year": "2020"
    },
    "opt": [
        {
            "key": "1",
            "val": "StreamingSamples"
        }
    ],
    "bill": {
      "ctry": "USA",
      "addr": "11 West 53 Street",
      "city": "Manhattan",
      "st": "NY",
      "zip": "10019"
    },
    "itms": [
      {
        ...
      }
    ]
  }
]

Example 2

{
  "doc": "DocumentCode12345",
  "cmmt": true,
}