Get

[POST] .../v1/docordertomovement/get

Returns transfer order documents. Use this method to list DocOrderToMovement movement order documents before opening a document, checking lock/delete state or editing its OrderToMovementOperation rows. The response returns paged movement order documents with next_offset and total; filters are id, status_id, stock_receiver_id, firm_receiver_id, attached_user_id, blocked, deleted_mark and date; date GreaterOrEqual maps to the start boundary and date LessOrEqual maps to the end boundary. The request supports sort_orders for the documented document columns. The query is constrained by the current request user's allowed receiver stocks and the tariff display-period rule. The caller must have movement order select permission; missing body, denied access, unavailable stock movement order tariff, invalid filters, database failures or display-period violations are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. Values above the configured query limit are replaced by the server query limit.
offset Int32 Optional Offset from the beginning of the result set. Negative values are treated as 0.
search String Optional Search by document code, receiver stock name, receiver firm name or TIN and responsible user full name. Search is applied only when the trimmed term is longer than the server search threshold.
sort_orders Array of DocOrderToMovementColumn Optional Output parameter sorting.

Filterable Fields

Field Type Description
attached_user_id int Responsible user IDs.
blocked bool Filter by document lock flag.
date int
deleted_mark bool Filter by deletion mark.
end_date int Period end date as Unix time in seconds. The tariff display-period filter validates the requested and returned period.
firm_receiver_id int Receiver firm IDs.
id int Movement order document IDs.
start_date int Period start date as Unix time in seconds. The tariff display-period filter can clamp a missing start date for broad queries.
status_id int Status IDs.
stock_receiver_id int Receiver stock IDs. Values are intersected with the current request user's allowed stocks.

Sortable Fields

Field
attached_user.name
blocked
code
date
deleted_mark
id
last_update
status.name
stock_receiver.name

Request Example

{
  "filters": [
    {
      "field": "stock_receiver_id",
      "operator": "In",
      "value": "12"
    },
    {
      "field": "status_id",
      "operator": "In",
      "value": "3"
    },
    {
      "field": "deleted_mark",
      "operator": "Equal",
      "value": "false"
    },
    {
      "field": "date",
      "operator": "GreaterOrEqual",
      "value": "1764547200"
    },
    {
      "field": "date",
      "operator": "LessOrEqual",
      "value": "1767225600"
    }
  ],
  "sort_orders": [
    {
      "column": "date",
      "direction": "DESC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of DocOrderToMovement Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 4401,
      "date": 1767225600,
      "code": "OTM-000041",
      "stock_receiver": {
        "id": 12,
        "name": "Downtown shop",
        "firm": {
          "id": 1,
          "name": "REGOS"
        }
      },
      "status": {
        "id": 3,
        "name": "New"
      },
      "attached_user": {
        "id": 5,
        "name": "John Smith"
      },
      "blocked": false,
      "current_user_blocked": null,
      "deleted_mark": false,
      "last_update": 1767225600
    }
  ],
  "next_offset": 0,
  "total": 1
}