# Словари для работы с претензиями

Словари, которыми описываются претензии ATI.SU: типы и уровни претензий, их статусы, роли участников, документы. Значения из этих словарей приходят в ответах методов претензий и передаются в их запросах.

Каждый метод отдаёт плоский список: у каждого элемента есть идентификатор и набор атрибутов. Состав полей и их описания смотрите в схеме ответа ниже.

#### Типы претензий

Типы претензий ATI.SU: за что участник выставляет претензию контрагенту, например неоплата, простой транспорта или утрата груза.

<a id="get-v1-dictionaries-claim_types"></a>

Получение словаря claim_types

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "claim_levels": "0,1",
      "claim_name": "Опоздание на загрузку/выгрузку (просрочка в доставке груза)",
      "for_type": "2"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.claim_levels` — Уровни, которые доступны для этого типа претензий.
- `[].attributes.claim_name` — Название типа претензии.
- `[].attributes.for_type` — Сторона, к которой выставляется претензия этого типа.


#### Сторона, к которой выставлена претензия

Сторона, к которой выставлена претензия: заказчик или исполнитель перевозки.

<a id="get-v1-dictionaries-claim_for_types"></a>

Получение словаря claim_for_types

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_for_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "К заказчику"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название стороны, к которой выставлена претензия.


#### Уровни претензии

Уровни претензии: для претензии-Лайт достаточно прикрепить Заявку, для претензии-Про необходимо прикрепить полный комплект документов.

<a id="get-v1-dictionaries-claim_levels"></a>

Получение словаря claim_levels

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_levels?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Претензия-про"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название уровня претензии.


#### Статусы претензии

Статусы претензии: опубликована, отклонена, урегулирована и прочие состояния её жизненного цикла.

<a id="get-v1-dictionaries-claim_statuses"></a>

Получение словаря claim_statuses

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Опубликована"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название статуса претензии.


#### Статусы модерации

Статусы модерации претензии: проверил ли претензию модератор ATI.SU и с каким результатом.

<a id="get-v1-dictionaries-claim_moderator_statuses"></a>

Получение словаря claim_moderator_statuses

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_moderator_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Проверена модератором"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название статуса модерации претензии.


#### Статусы связи ответчика

Статусы связи ответчика по претензии с юридическим лицом, указанным в её документах: подтверждена ли связь и на каком основании.

<a id="get-v1-dictionaries-claim_connection_statuses"></a>

Получение словаря claim_connection_statuses

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_connection_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Не подтверждена"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название статуса связи ответчика с фирмой по документам.


#### Статусы оспоренности

Статусы оспоренности претензии: заявил ли ответчик несогласие с претензией по существу.

<a id="get-v1-dictionaries-claim_challenge_statuses"></a>

Получение словаря claim_challenge_statuses

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_challenge_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Не оспорена"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название статуса оспоренности претензии.


#### Роли участника претензии

Роли участника претензии: истец — участник, который добавил претензию; ответчик — участник, в адрес которого добавили претензию.

<a id="get-v1-dictionaries-claim_roles"></a>

Получение словаря claim_roles

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_roles?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Истец"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название роли участника претензии.


#### Поля сортировки списка претензий

Поля, по которым упорядочивается список претензий: дата, сумма, имя стороны.

<a id="get-v1-dictionaries-claim_sort_types"></a>

Получение словаря claim_sort_types

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_sort_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "По дате"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название поля, по которому упорядочивается список претензий.


#### Типы документов претензии

Типы документов, которые прикладываются к претензии: договор, заявка, транспортная накладная, акт и прочие. Список обязательных документов для каждого типа претензии определяется «[Положением о Претензиях](https://files.ati.su/static/front-files/claims-rules-policy.pdf)».

<a id="get-v1-dictionaries-claim_doc_types"></a>

Получение словаря claim_doc_types

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_doc_types?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "ТН (Транспортная накладная)"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название типа документа претензии.


#### Статусы документа претензии

Статусы отдельного документа претензии: проверен ли документ модератором ATI.SU.

<a id="get-v1-dictionaries-claim_doc_statuses"></a>

Получение словаря claim_doc_statuses

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_doc_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Документ проверен"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название статуса документа претензии.


#### Состояния проверки электронного документа

Состояния проверки электронного документа претензии: отправлен на проверку, проверка пройдена и прочие.

<a id="get-v1-dictionaries-claim_digital_document_statuses"></a>

Получение словаря claim_digital_document_statuses

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_digital_document_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Проверка пройдена"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название состояния проверки электронного документа.


#### Состояния черновика претензии

Состояния черновика претензии, добавленной с электронными документами: идёт ли по нему проверка и чем она закончилась.

<a id="get-v1-dictionaries-claim_draft_statuses"></a>

Получение словаря claim_draft_statuses

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/gw/marshak/v1/dictionaries/claim_draft_statuses?locale=ru' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/dictionaries/claims.openapi.json)

**Описание параметров запроса**
- `locale (query, тип: string)` — Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy

**Пример ответа (200)**

```json
[
  {
    "dictionary_item_id": 1,
    "attributes": {
      "name": "Проверка пройдена, черновик материализован в претензию"
    }
  }
]
```

**Описание полей ответа**
- `[].dictionary_item_id` — Идентификатор элемента словаря
- `[].attributes` — Поля элемента: ключ — имя поля, значение — строка
- `[].attributes.name` — Название состояния черновика претензии.
---

## llms.txt

Индекс ключевых страниц документации для LLM и AI-агентов доступен в [основном llms.txt](https://ati.su/developers/llms.txt).