PerformCancel

[POST] .../v1/docpurchase/performcancel

Cancels posting of partner receipt document. Use this destructive workflow method to cancel posting for a receipt-from-partner document when the posted state must be reversed. It changes the document back to unperformed state, writes the cancellation action log, sends the purchase-perform-canceled webhook and returns row_affected. The caller must have perform-cancel permission and provide a positive id; locked documents, missing documents, closed-period restrictions, unchanged rows and storage failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id Int64 Required Record ID.

Request Example

{
  "id": 1
}

Response Parameters

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

Response Example

{
  "ok": true,
  "result": {
    "ids": [
      null
    ],
    "row_affected": 1
  }
}