PerformCancel

[POST] .../v1/docpayment/performcancel

Cancels posting of payment document. Cancel posting for a payment document when the finance movement must be rolled back. The operation returns row_affected, clears the posted flag entry, sends the DocPaymentPerformCanceled webhook and requires perform-cancel permission for the current request user. It succeeds only for currently posted documents that are not marked for deletion and not deleted and it should be used before editing or deleting a payment that was already posted. Missing body, invalid id, denied permission, disabled payment tariff, unposted documents, marked/deleted documents, storage errors and storage conflicts are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
id Int64 Required Required payment document ID.

Request Example

{
  "id": 42
}

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
  }
}