Lock

[POST] .../v1/docinventory/lock

Locks inventory count documents for editing. Lock one or more inventory documents before editing headers, changing rows, moving rows or closing/opening the document in workflows that follow the document lock contract. The request body must contain a non-empty ids array with positive document IDs and the stock inventory tariff option must be enabled; the RBAC permission check for Lock is currently disabled. The response reports how many document lock rows changed and locked documents expose current_user_blocked in DocInventory/Get for the current request user. Errors such as missing body, missing ids, invalid IDs, disabled tariff option, lock conflicts, storage errors or lock errors are returned as HTTP 200 ErrorResult.

Request Parameters

Request Example

{
  "ids": [
    1
  ]
}

Response Parameters

Response Example

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