# Об’єкт XSearchDocsQuery (Критерії пошуку/фільтрації «Товарних узгоджень» AGREEM)

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

<div class="wy-table-responsive" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%A4%D0%BE%D1%80%D0%BC%D0%B0%D1%82-%D0%9E%D0%BF%D0%B8%D1%81"><table class="colwidths-given docutils align-default" style="width: 100%;"><colgroup><col style="width: 17.751%;"></col><col style="width: 17.9973%;"></col><col style="width: 64.2278%;"></col></colgroup><thead><tr class="row-odd"><th class="head">Параметр

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

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

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

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

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

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

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

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

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

</td><td>Long

</td><td>id мережі (ритейлера)

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

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

</td><td>масив; список мереж (ритейлерів)

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

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

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

- 1 - Чернетка (на стороні постачальника)
- 2 - Відправлено (на стороні постачальника)
- 3 - На узгодженні (на стороні постачальника)
- 4 - Відхилено (на стороні постачальника)
- 5 - Підписання постачальником (на стороні постачальника)
- 6 - 2 підписання постачальником (на стороні постачальника)
- 7 - Завершено (на стороні постачальника)
- 11 - Відхилено (на стороні мережі)
- 12 - На узгодженні (на стороні мережі)
- 13 - Підготовлено (на стороні мережі)
- 14 - Готовий до підписання (на стороні мережі)
- 15 - Погоджено (на стороні мережі)
- 16 - Підписано (на стороні мережі)
- 17 - Перевірено (на стороні мережі)
- 18 - Підтверджено (на стороні мережі)
- 19 - Підписання постачальником (на стороні мережі)
- 20 - Підписання мережею (на стороні мережі)

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

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

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

- 1 - Регулярна ціна;
- 3 - Комерційна пропозиція;
- 2 - Промо ціна;
- 5 - Промо ціна - Компенсація;
- 6 - Промо ціна - Комбо

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

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

</td><td>масив; id Gln-нів контрагентів

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

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

</td><td>об’єкт; номер контракту/специфікації

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

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

</td><td>об’єкт; опис контракту/специфікації

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

</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>**dateChanged**

</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>**docDate**

</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>**limit**

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

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

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

</td><td>String

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

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

</td><td>Boolean

</td><td>відмітка про те, що документ оброблений (архівний)

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

</td><td>Boolean

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

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

</div>**JSON приклади:**

<details id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-20-%D0%BE%D1%81%D1%82%D0%B0%D0%BD%D0%BD%D1%96%D1%85"><summary>Отримати 20 останніх неархівних (необроблених) «Товарних узгоджень» (AGREEM) для Відправника «13200665»</summary>

```
{
  "indexes": [],
  "types": [],
  "statuses": [],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "archive": false,
  "limit": {
    "count": 20,
    "offset": 0
  }
}
```

</details><details id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-20-%D0%BE%D1%81%D1%82%D0%B0%D0%BD%D0%BD%D1%96%D1%85-1"><summary>Отримати 20 останніх важливих завершених «Товарних узгоджень» (AGREEM) типу «Промо ціна» для Відправника «13200665»</summary>

```
{
  "indexes": [
    {
      "operator": "AND",
      "type": "EQUALS",
      "fieldName": "isFavorite",
      "value": "true"
    }
  ],
  "types": [
    2
  ],
  "statuses": [
    7
  ],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "limit": {
    "count": 20,
    "offset": 0
  }
}
```

</details><details id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-20-%D0%BE%D1%81%D1%82%D0%B0%D0%BD%D0%BD%D1%96%D1%85-2"><summary>Отримати 20 останніх оброблених (архівних) «Товарних узгоджень» (AGREEM) типу «Регулярна ціна» для Відправника «13200665» з датою документа за період 2021-07-01-2021-07-27</summary>

```
{
  "indexes": [],
  "types": [
    1
  ],
  "statuses": [],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "archive": true,
  "docDate": {
    "startTimestamp": 1625086800,
    "finishTimestamp": 1627419599
  },
  "limit": {
    "count": 20,
    "offset": 0
  }
}
```

</details><details id="bkmrk-%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D1%82%D0%B8-40-%D0%BE%D1%81%D1%82%D0%B0%D0%BD%D0%BD%D1%96%D1%85"><summary>Отримати 40 останніх необроблених (неархівних) «Товарних узгоджень» (AGREEM) для Відправника «13200665» з номером контракту «666.333333»</summary>

```
{
  "indexes": [],
  "types": [],
  "statuses": [],
  "direction": {
    "type": "EQ",
    "sender": [
      13200665
    ]
  },
  "archive": false,
  "contractNumber": {
    "operator": "AND",
    "type": "EQUALS",
    "value": "666.333333"
  },
  "limit": {
    "count": 40,
    "offset": 0
  }
}
```

</details>