Edit

[POST] .../v1/returnstopartneroperation/edit

Edits operation return partner. Use this method to update one or more existing item lines in a DocReturnsToPartner return document before posting or other state restrictions prevent changes. The request body is a JSON array batch where each item must contain an operation id; optional quantity, cost, order, vat_value and description fields change only the provided values and description is limited to 300 characters. The operation must belong to a return-to-partner document, the parent document must be locked by the current user and eligible for editing and the caller must have edit permission; null, empty or oversized arrays, missing ids, invalid numeric values, denied access, no changed fields or document state conflicts are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
cost Decimal Optional New returned item cost. When provided, it must be zero or greater and no greater than 99999999999.
description String Optional Operation note. Maximum length is 300 characters; null means no change.
id Int64 Required Return-to-partner operation ID.
order Int64 Optional Operation order. If NULL, the database value is not changed. Ignored for database versions earlier than 363.
quantity Decimal Optional New item quantity returned to the partner. When provided, it must be greater than zero and no greater than 999999999.
vat_value Decimal Optional New VAT rate value. When provided, it must be non-negative or -1 for document/default VAT behavior.

Request Example

[
  {
    "id": 8401,
    "quantity": 1,
    "cost": 40500,
    "order": 20,
    "vat_value": 12,
    "description": "Adjusted damaged return quantity"
  }
]

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,
    "ids": [
      8401
    ]
  }
}