# Об’єкт StorageQuery (Дані для фільтрації)

#### **Опис параметрів об’єкта**

<table class="colwidths-given docutils align-default" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%A2%D0%B8%D0%BF-1-%D0%A4%D0%BE%D1%80%D0%BC%D0%B0" style="width: 100%;"><colgroup><col style="width: 15.1371%;"></col><col style="width: 7.27056%;"></col><col style="width: 23.7179%;"></col><col style="width: 53.8745%;"></col></colgroup><thead><tr class="row-odd"><th class="head">Параметр

</th><th class="head">Тип <sup>1</sup>

</th><th class="head">Формат

</th><th class="head">Опис

</th></tr></thead><tbody><tr class="row-odd"><td>**extraParams**

</td><td> </td><td>List&lt;[ExtraQueryParameters](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-extraqueryparameters)&gt;

</td><td>масив об’єктів; набір індексів

</td></tr><tr class="row-even"><td>**multiExtraParams**

</td><td> </td><td>List&lt;[ExtraQueryParameters](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-extraqueryparameters)&gt;

</td><td>масив об’єктів; мультиіндекс (може приймати масив параметрів з масивами значень для кожного з параметрів)

</td></tr><tr class="row-odd"><td>**type**

</td><td>M

</td><td>List&lt;[XDocType](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-xdoctype)&gt;

</td><td>масив об’єктів; список типів документів: 0 - всі типи, 1/2/3 … і більше - конкретний тип документа

</td></tr><tr class="row-even"><td>**statuses**

</td><td>M

</td><td>List&lt;Integer&gt;

</td><td>масив; список статусів (станів) документів, за якими буде відбуватися відбір:

- 0 - all (всі)
- 1 - open (чернетки)
- 2 - sent (відправлені-Відправник)
- 3 - delivered (доставлені-Відправник)
- 4 - inbox (вхідні-Отримувач)
- 5 - read (прочитані-Отримувач)
- 6 - error (помилка)
- 7 - deleted (видалені)

</td></tr><tr class="row-odd"><td>**extraStatuses**

</td><td> </td><td>List&lt;Integer&gt;

</td><td>масив; список екстрастатусів

</td></tr><tr class="row-even"><td>**tags**

</td><td> </td><td>List&lt;Long&gt;

</td><td>масив; тег

</td></tr><tr class="row-odd"><td>**exchangeStatus**

</td><td>O

</td><td>List&lt;Integer&gt;

</td><td>масив; статус документообігу

</td></tr><tr class="row-even"><td>**docs**

</td><td> </td><td>List&lt;Long&gt;

</td><td>масив; документи

</td></tr><tr class="row-odd"><td>**docUUIDs**

</td><td> </td><td>List&lt;UUID&gt;

</td><td>масив; унікальні ідентифікатори документів

</td></tr><tr class="row-even"><td>**partners**

</td><td> </td><td>List&lt;Long&gt;

</td><td>масив; ідентифікатори контрагентів

</td></tr><tr class="row-odd"><td>**families**

</td><td> </td><td>List&lt;Integer&gt;

</td><td>масив; ознака сервісу (сімейство)

- 1 - EDI+ЮЗД
- 7 - ЕТТН

</td></tr><tr class="row-even"><td>**direction**

</td><td>M

</td><td>[Direction](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-direction)

</td><td>об’єкт; напрямок документообігу; вказуються відправник, отримувач і зв’язок між ними в умовах відбору документів

</td></tr><tr class="row-odd"><td>**limit**

</td><td>O

</td><td>[Limitation](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-limitation)

</td><td>об’єкт; фільтр відбору (налаштування виводу даних)

</td></tr><tr class="row-even"><td>orderBy

</td><td>O

</td><td>OrderBy

</td><td>фільтрувати по даті чи опису документа

</td></tr><tr class="row-odd"><td>groupBy

</td><td>O

</td><td>String

</td><td>об’єднані по id ланцюжка/документа

</td></tr><tr class="row-even"><td>number

</td><td>O

</td><td>String

</td><td>номер документа

</td></tr><tr class="row-odd"><td>family

</td><td>O

</td><td>int

</td><td>сімейство

- 1 - EDI
- 2 - UZD
- 4 - CERTIFICATS
- 6 - ATS
- 7 - ETTN
- 8 - DISTRIBUTION
- 9 - SIMPLEDOC (Вільний)
- 10 - TENDER
- 11 - AGREEMENT
- 12 - OPENPRICE (Є-Товар)

</td></tr><tr class="row-even"><td>partnerId

</td><td> </td><td>Long

</td><td>id роздрібної мережі

</td></tr><tr class="row-odd"><td>chainHash

</td><td> </td><td>String

</td><td>хеш-значення, отримане в результаті обробки ланцюжка

</td></tr><tr class="row-even"><td>docHash

</td><td> </td><td>String

</td><td>хеш-значення, отримане в результаті обробки документа

</td></tr><tr class="row-even"><td>**docCreate**

</td><td>O

</td><td>[DateTimeRange](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-datetimerange)

</td><td>об’єкт; дата створення документа (у форматі UNIX-timestamp) з / по

</td></tr><tr class="row-odd"><td>**docRead**

</td><td>O

</td><td>[DateTimeRange](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-datetimerange)

</td><td>об’єкт; дата прочитання документа (у форматі UNIX-timestamp) з / по

</td></tr><tr class="row-even"><td>**docChanged**

</td><td>O

</td><td>[DateTimeRange](https://wiki-v2.edin.ua/books/robota-z-api/page/objekt-datetimerange)

</td><td>об’єкт; дата останньої зміни документа (у форматі UNIX-timestamp) з / по

</td></tr><tr class="row-odd"><td>archive

</td><td> </td><td>Boolean

</td><td>відмітка наявності архівної ознаки документа

</td></tr><tr class="row-even"><td>important

</td><td> </td><td>boolean

</td><td>відмітка **важливий** документ

</td></tr><tr class="row-odd"><td>visible

</td><td> </td><td>boolean

</td><td>відмітка видимості

</td></tr><tr class="row-even"><td>loadBody

</td><td> </td><td>boolean

</td><td>відмітка наявності тіла документа

</td></tr><tr class="row-odd"><td>loadComments

</td><td> </td><td>boolean

</td><td>відмітка наявності коментарів до документа

</td></tr><tr class="row-even"><td>loadStatuses

</td><td> </td><td>boolean

</td><td>відмітка наявності статусів документа

</td></tr><tr class="row-odd"><td>loadTags

</td><td> </td><td>boolean

</td><td>відмітка наявності тегів документа

</td></tr><tr class="row-even"><td>loadChain

</td><td> </td><td>boolean

</td><td>відмітка наявності ланцюжка документів

</td></tr><tr class="row-odd"><td>loadAttachments

</td><td> </td><td>boolean

</td><td>відмітка наявності вкладень

</td></tr></tbody></table>

#### **Приклади для сервісу «EDI Network»**

##### Отримати всі документи-чернетки, в яких відправником зазначений GLN 9864065732303

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22arch"><summary>JSON приклад</summary>

```
{
    "archive": false,
    "direction":
    {
        "type": "EQ",
        "sender":
        [
            "9864065732303"
        ]
    },
    "exchangeStatus":
    [],
    "family": 1,
    "limit":
    {
        "offset": "0",
        "count": 21
    },
    "statuses":
    [
        1
    ],
    "tags":
    [],
    "type":
    [
        {
            "type": 0,
            "title": "all",
            "description": "all"
        }
    ],
    "families":
    [
        1,
        7
    ]
}
```

</details>##### Отримати всі вхідні «Видаткові накладні», що знаходяться в статусі «Потребує підписання отримувачем»

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22stat"><summary>JSON приклад</summary>

```
{
  "statuses": [4, 5, 6],
  "type": [
    {
      "type": 28
    }
  ],
  "limit": {
    "offset": "0",
    "count": 21
  },
  "exchangeStatus": [
    1
  ],
  "extraParams": [
    {
      "operator": "AND",
      "type": "EQUALS",
      "value": "6",
      "fieldName": "sub_doc_type_id"
    },
    {
      "operator": "AND",
      "type": "EQUALS",
      "value": "1",
      "fieldName": "sub_status_id"
    }
  ],
  "tags": [],
  "archive": false,
  "direction": {
    "type": "EQ",
    "receiver": [
      "9864066822430"
    ],
    "sender": []
  },
  "family": 1
}
```

</details>##### Отримати всі документи, окрім чернеток (масив statuses не містить «1»), в яких отримувачем є GLN 9864232304302

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22dire"><summary>JSON приклад</summary>

```
{
    "direction": {
        "sender": [],
        "receiver": ["9864232304302"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "type": [
        {
            "type": "0"
        }
    ]
}
```

</details>##### Отримати всі документи, окрім чернеток (масив statuses не містить «1»), в яких відправником є GLN 9864232304302

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22dire-1"><summary>JSON приклад</summary>

```
{
    "direction": {
        "sender": ["9864232304302"],
        "receiver": [],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "type": [
        {
            "type": "0"
        }
    ]
}
```

</details>##### Отримати всі вхідні документи (GLN отримувача 9864232304302)

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22dire-2"><summary>JSON приклад</summary>

```
{
    "direction": {
        "sender": [],
        "receiver": ["9864232304302"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["4","5","6"],
    "type": [
        {
            "type": "0"
        }
    ]
}
```

</details>##### Отримати всі відправлені документи (GLN відправника 9864232304302)

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22dire-3"><summary>JSON приклад</summary>

```
{
    "direction": {
        "sender": ["9864232304302"],
        "receiver": [],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","6"],
    "type": [
        {
            "type": "0"
        }
    ]
}
```

</details>##### Отримати документи з номером, рівним значенню «1001» (пошук серед усіх документів, окрім чернеток), в яких отримувачем є GLN 9864232304302

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22dire-4"><summary>JSON приклад</summary>

```
{
    "direction": {
        "sender": [],
        "receiver": ["9864232304302"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "number": "1001",
    "type": [
        {
            "type": "0"
        }
    ]
}
```

</details>##### Отримати всі документи, окрім чернеток, для GLN відправника 9864232304302, що створені в травні 2019 (startTimestamp і finishTimestamp дати в форматі UNIX-timestamp за київським часом відносно UTC)

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22dire-5"><summary>JSON приклад</summary>

```
{
    "direction": {
        "sender": ["9864232304302"],
        "receiver": [],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "family": "1",
    "statuses": ["2","3","4","5","6","7"],
    "type": [
        {
            "type": "0"
        }
    ],
    "extraParams": [
      {
        "operator": "AND",
        "type": "MORE_EQ",
        "fieldName": "doc_date",
        "value": "1556668800"
      },
      {
        "operator": "AND",
        "type": "LESS_EQ",
        "fieldName": "doc_date",
        "value": "1559347199"
      }
}
```

</details>#### **Приклади для сервісу «Маркет»**

##### Отримати список всіх відправлених «Замовлень» (ORDERS) для GLN відправника 9864232324065

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22arch-1"><summary>JSON приклад</summary>

```
{
    "archive": false,
    "direction": {
        "receiver": [],
        "sender": ["9864232324065"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "extraParams": [],
    "family": 8,
    "multiExtraFields": [],
    "statuses": [2],
    "type": [
        {
            "type": 2
        }
    ]
}
```

</details>##### Отримати список всіх чернеток «Замовлень» (ORDERS) для GLN 9864232324065 (створювач-відправник)

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22arch-2"><summary>JSON приклад</summary>

```
{
    "archive": false,
    "direction": {
        "receiver": [],
        "sender": ["9864232324065"],
        "type": "EQ"
    },
    "exchangeStatus": [],
    "extraParams": [],
    "family": 8,
    "multiExtraFields": [],
    "statuses": [1],
    "type": [
        {
            "type": 2
        }
    ]
}
```

</details>#### **Приклади для сервісу «Вільний»**

##### Отримати всі надіслані документи («statuses»: 2,3), що очікують підпису («action»: 0)

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22stat-1"><summary>JSON приклад</summary>

```json
{
  "statuses": [
    2,
    3
  ],
  "type": [
    {
      "type": 0
    }
  ],
  "limit": {
    "count": 21,
    "offset": "0"
  },
  "exchangeStatus": [],
  "extraParams": [
    {
      "operator": "AND",
      "type": "IN",
      "value": "0",
      "fieldName": "action"
    }
  ],
  "multiExtraParams": [],
  "tags": [],
  "archive": false,
  "direction": {
    "type": "EQ",
    "sender": [
      "7c30a623-b84f-44d1-bda1-fdcc5f8be3d7"
    ],
    "receiver": []
  },
  "loadChain": true,
  "family": 9
}
```

</details>##### Отримати всі вхідні документи («statuses»: 4,5) від вказаного відправника/-ів (sender:uuid)

<details id="bkmrk-json-%D0%BF%D1%80%D0%B8%D0%BA%D0%BB%D0%B0%D0%B4-%7B-%22stat-2"><summary>JSON приклад</summary>

```json
{
  "statuses": [
    4,
    5
  ],
  "type": [
    {
      "type": 0
    }
  ],
  "limit": {
    "count": 21,
    "offset": "0"
  },
  "exchangeStatus": [],
  "extraParams": [],
  "multiExtraParams": [],
  "tags": [],
  "archive": false,
  "direction": {
    "type": "EQ",
    "sender": [
      "831714cf-064b-4ce9-bdc4-b6a79784639c"
    ],
    "receiver": [
      "7c30a623-b84f-44d1-bda1-fdcc5f8be3d7"
    ]
  },
  "loadChain": true,
  "family": 9
}
```

</details>---

<dl class="footnote brackets" id="bkmrk-%5B1%5D---%D0%9F%D1%96%D0%B4-%D0%B2%D0%B8%D0%B7%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%BD%D1%8F"><dt class="label" id="bkmrk-%5B2%5D---%D0%B5%D0%BB%D0%B5%D0%BC%D0%B5%D0%BD%D1%82%D0%B8-%D1%81%D1%82%D1%80%D1%83%D0%BA">\[1\] - Під визначенням колонки **Тип** мається на увазі скорочене позначення:</dt><dd><dl class="footnote brackets"><dd>- M (mandatory) — обов’язкові до заповнення поля;
- O (optional) — необов’язкові (опціональні) до заповнення поля.

</dd></dl></dd></dl>