Add

[POST] .../v1/returnstopartneroperation/add

Creates a new operation return partner. Use this method to add one or more item lines to a DocReturnsToPartner return document before the document is posted. The request body is a JSON array batch; every operation must contain document_id, item_id, positive quantity up to 999999999, cost from 0 to 99999999999, optional order, optional VAT value and optional description up to 300 characters and all array items must reference the same document_id. The parent DocReturnsToPartner must be locked by the current user and eligible for editing and the item must be an active non-compound leaf item that is allowed for this document type; null, empty or oversized arrays, invalid values, mixed document_ids, denied access or document/item state conflicts are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
cost Decimal Required Returned item cost. Required; zero is allowed, negative values are rejected and the value must be no greater than 99999999999.
description String Optional Operation note. Maximum length is 300 characters.
document_id Int64 Required Return-to-partner document ID.
item_id Int64 Required Item ID.
order Int64 Optional Operation order. NULL means not set and is stored as NULL in the database. Ignored for database versions earlier than 363.
quantity Decimal Required Item quantity returned to the partner. Must be greater than zero and no greater than 999999999.
vat_value Decimal Optional VAT rate value. Null uses the item's VAT rate; -1 is accepted for document/default VAT behavior.

Request Example

[
  {
    "document_id": 4501,
    "item_id": 1001,
    "quantity": 2,
    "cost": 41000,
    "order": 10,
    "vat_value": 12,
    "description": "Return damaged packages to partner"
  }
]

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