CancelClose

[POST] .../v1/docperiodclosing/cancelclose

Cancels period closing document Use this destructive workflow method to cancel a period closing document before deleting it or before replacing it with a new closing workflow. The request body is required, id is required, the caller needs the period closing cancel permission and the document must be locked for cancellation. Cancellation is rejected when a later non-canceled period exists for the same firm, when the document is missing or when an InProcess document was updated less than 24 hours ago. The response returns row_affected and fires the DocPeriodClosingCanceled webhook; business errors such as missing body, invalid id, denied access, later-period conflicts, in-process waiting restrictions, no matching row or database failures are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Required period closing document ID.

Request Example

{
  "id": 44
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}