Get

[POST] .../v1/docorderfrompartner/get

Returns order-from-partner document. Use this method to list order-from-partner documents before opening a customer order, checking reservation and lock state, editing OrderFromPartnerOperation rows or copying the order into a wholesale shipment workflow. The response returns paged order-from-partner documents with next_offset and total; filters are id, firm_id, stock_id, partner_id, contract_id, status_id, attached_user_id, vat_calculation_type, 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 both the tariff display-period rule and the current user's allowed_stocks. The caller must have order-from-partner select permission; missing body, denied access, unavailable stock-from-partner 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, stock name, partner name or TIN, responsible user full name, contract code, firm name or firm TIN. Search is applied only when the trimmed term is longer than the server search threshold.
sort_orders Array of DocOrderFromPartnerColumn Optional Output parameter sorting.

Filterable Fields

Field Type Description
attached_user_id int Responsible user IDs.
blocked bool Filter by document lock flag.
contract_id int Contract IDs.
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_id int Company IDs.
id int Order-from-partner document IDs.
partner_id int Partner 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_id int Stock IDs.
vat_calculation_type string VAT calculation mode: No - do not accrue, Exclude - included in the amount, Include - added on top.

Sortable Fields

Field
amount
attached_user.name
blocked
booked
code
contract.name
currency.name
date
deleted_mark
firm.name
id
last_update
partner.name
status.name
stock.name
vat_calculation_type

Request Example

{
  "filters": [
    {
      "field": "stock_id",
      "operator": "In",
      "value": "101"
    },
    {
      "field": "partner_id",
      "operator": "In",
      "value": "201"
    },
    {
      "field": "status_id",
      "operator": "Equal",
      "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 DocOrderFromPartner Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 4601,
      "date": 1767225600,
      "code": "OFP-000045",
      "contract": {
        "id": 301,
        "code": "CNT-2026-02",
        "name": "Customer contract"
      },
      "partner": {
        "id": 201,
        "name": "City Retail LLC"
      },
      "currency": {
        "id": 1,
        "code_chr": "USD",
        "name": "US Dollar"
      },
      "stock": {
        "id": 101,
        "name": "Main warehouse"
      },
      "exchange_rate": 1,
      "vat_calculation_type": "Include",
      "amount": 5400,
      "status": {
        "id": 3,
        "name": "New"
      },
      "attached_user": {
        "id": 5,
        "name": "John Smith"
      },
      "booked": true,
      "blocked": false,
      "current_user_blocked": null,
      "deleted_mark": false,
      "last_update": 1767225600,
      "description": "January customer order"
    }
  ],
  "next_offset": 0,
  "total": 1
}