> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Предпросмотр записи

> Предварительно посмотреть пробирки и счёт для записи

Возвращает всё, что нужно для записи с учётом её панелей и биомаркеров. Заказ при этом не создаётся.

* `containers`: пробирки, карты или контейнеры, которые готовит специалист.
* `pricing`: счёт по твоему прайс-листу. [Рассчитать корзину](https://docs.anivahealth.com/ru/api/pricing/quote-cart.md) возвращает тот же
  счёт без записи.
* `routing`: всегда `null`.

Требуется одно из разрешений: `appointments_view`, `appointments_schedule`, `appointments_operate` или `appointments_manage`.

## Запрос

### Параметры пути

**id** `string` *required*

Уникальный идентификатор (UUID) записи для предпросмотра требований к контейнерам.

## Ответ

При успехе API возвращает `200 OK` с требованиями к контейнерам и полями, зарезервированными на будущее.

**containers** `object[]` *required*

Массив необходимых контейнеров для сбора биоматериала. Пустой, если к записи не добавлены панели или биомаркеры. Также пустой, если день и локацию записи ещё нельзя определить — например, когда не назначено время.

**контейнер**

**type** `string`

Идентификатор типа контейнера. Одно из значений: `serum`, `serum_capillary`, `serum_capillary_plain`, `edta`, `edta_capillary`, `citrate`, `lihep`, `lihep_capillary`, `glucoexact`, `fluoride`, `fluoride_capillary`, `homocysteine`, `urine`, `dried_blood_spot`, `swab`, `stool`, `saliva`, `hair` или `trace_metal`.

**name** `string`

Человекочитаемое название контейнера (например, «Serum», «EDTA», «Li-Heparin»).

**cap\_color** `string`

HEX-код цвета крышки контейнера для отображения (например, `"#A0784B"`). `null`, если у
контейнера нет крышки.

**volume** `string`

Объём контейнера (например, `"7.5 ml"`). `null`, если объём неприменим.

**article\_number** `string`

Каталожный номер производителя (REF), если он известен (например, `"01.1602.001"`). Отсутствует для контейнеров без сопоставленного артикула.

**count** `integer`

Необходимое количество контейнеров этого типа.

**routing** `null`

Детали маршрутизации в лабораторию — намеренно скрыты, всегда `null`.

**pricing** `object | null`

Общий счёт по корзине для записи по твоему прайс-листу. `null`, если к записи не привязаны
анализы или у твоего ключа нет разрешения `prices_view`. [Ценообразование](https://docs.anivahealth.com/ru/concepts/pricing.md) объясняет
модель; отдельные суммы соответствуют справочнику [объектов
цен](https://docs.anivahealth.com/ru/api/biomarkers/list-biomarkers.md#obyekty-tsen).

**Поля счёта**

**total\_cents** `integer`

Стоимость корзины по твоему прайс-листу: позиции с ценой плюс панели с ценой плюс строки
биомаркеров с ценой. Строка с `price_cents: null` ничего не добавляет, поэтому итог корзины с такой строкой
меньше фактической стоимости.

**retail\_total\_cents** `integer`

Та же итоговая сумма по рекомендованному розничному прайс-листу.

**fees** `object`

Сборы, которые добавляет один забор крови по твоему прайс-листу, в центах. Они включаются в ежемесячный счёт. См. [Получить
прайс-лист](https://docs.anivahealth.com/ru/api/pricing/get-rate-card.md).

**сборы**

**phlebotomy\_fee\_cents** `integer`

Сбор за забор крови за каждую завершённую запись.

**snack\_fee\_cents** `integer`

Перекус для пациента. Выставляется только тогда, когда пациент получает перекус. Отсутствует, если твои
пациенты его не получают; свяжись с Aniva, чтобы добавить перекусы.

**logistics\_fee\_cents** `integer`

Курьерский сбор за забор образцов. Твои записи в одной локации в один день делят один
сбор.

**material\_fee\_cents** `integer`

Расходные материалы: пробирки, этикетки, пакет.

**total\_with\_fees\_cents** `integer`

`total_cents` плюс все сборы из `fees`, включая полную стоимость логистики. Сумма будет меньше,
если другая твоя запись использует тот же курьерский забор.

**positions** `object[]`

Каждая позиция, сработавшая для этой корзины — оплачивается один раз целиком и даёт весь свой
набор элементов. Содержит `id`, `name`, `price_cents`, `retail_cents` и `tier`. Позиция, не
видимая партнёру, всё равно срабатывает и оплачивается, а в ответе для неё `id` и `name` равны
`null`.

**panels** `object[]`

Каждая прикреплённая панель в виде `id`, `name`, `price_cents` и `retail_cents`.

**biomarkers** `object[]`

По одной строке на каждый **выдаваемый** биомаркер — запрошенные тобой биомаркеры, плюс
компоненты, подтянутые их соотношениями, и элементы, которые дают сработавшие позиции.

**id** `number`

Идентификатор биомаркера.

**name** `string`

Отображаемое название биомаркера.

**price\_cents** `integer | null`

Сколько эта строка стоит по твоему тарифу, рядом с `retail_cents`. `0`, если её покрывает
позиция; `null`, если Aniva не может определить цену.

**required\_by** `number[]`

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

**requires** `number[]`

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

**via\_position** `string`

Позиция, оплачивающая этот маркер, из-за чего строка стоит `0`. Не передаётся, если его ничего
не покрывает. `null`, если покрывающая позиция не видна партнёру.

## Ответы с ошибками

| Статус | Описание |
| - | - |
| `400` | Неверный формат ID — переданное значение не является корректным UUID. |
| `403` | Доступ запрещён — у твоего API-ключа нет доступа к этой операции. |
| `404` | Запись не найдена. |
| `500` | Внутренняя ошибка сервера. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/preview \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "containers": [
    {
      "type": "serum",
      "name": "Serum",
      "cap_color": "#A0784B",
      "volume": "7.5 ml",
      "article_number": "01.1602.001",
      "count": 3
    },
    {
      "type": "edta",
      "name": "EDTA",
      "cap_color": "#D13438",
      "volume": "3.4 ml",
      "article_number": "04.1914.001",
      "count": 2
    },
    {
      "type": "glucoexact",
      "name": "GlucoEXACT",
      "cap_color": "#9E9E9E",
      "volume": "3.1 ml",
      "article_number": "05.1074.001",
      "count": 1
    }
  ],
  "routing": null,
  "pricing": {
    "total_cents": 13751,
    "retail_total_cents": 17029,
    "fees": {
      "phlebotomy_fee_cents": 2500,
      "snack_fee_cents": 500,
      "logistics_fee_cents": 2000,
      "material_fee_cents": 250
    },
    "total_with_fees_cents": 19001,
    "positions": [
      {
        "id": "b7d4c2e1-9a3f-4c8b-91d2-5e6f7a8b9c0d",
        "name": "Aniva Blood Count",
        "price_cents": 452,
        "retail_cents": 520,
        "tier": "routine"
      }
    ],
    "panels": [
      {
        "id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "name": "Hormones (Female)",
        "price_cents": 11900,
        "retail_cents": 14900
      }
    ],
    "biomarkers": [
      { "id": 42, "name": "HDL Cholesterol", "price_cents": 233, "retail_cents": 268, "required_by": [279] },
      {
        "id": 71,
        "name": "Hemoglobin",
        "price_cents": 0,
        "retail_cents": 0,
        "via_position": "b7d4c2e1-9a3f-4c8b-91d2-5e6f7a8b9c0d"
      },
      { "id": 84, "name": "High-Sensitivity C-Reactive Protein (hs-CRP)", "price_cents": 1166, "retail_cents": 1341, "required_by": [279] },
      { "id": 279, "name": "hs-CRP / HDL Ratio", "price_cents": 0, "retail_cents": 0, "requires": [42, 84] }
    ]
  }
}
```

```json 200 (no panels) theme={null}
{
  "containers": [],
  "routing": null,
  "pricing": null
}
```

```json 200 (one item without a price) theme={null}
{
  "containers": [],
  "routing": null,
  "pricing": {
    "total_cents": 11900,
    "retail_total_cents": 14900,
    "fees": {
      "phlebotomy_fee_cents": 2500,
      "snack_fee_cents": 500,
      "logistics_fee_cents": 2000,
      "material_fee_cents": 250
    },
    "total_with_fees_cents": 17150,
    "positions": [],
    "panels": [
      {
        "id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "name": "Hormones (Female)",
        "price_cents": 11900,
        "retail_cents": 14900
      }
    ],
    "biomarkers": [{ "id": 555, "name": "Poppy Seeds (Pap s)", "price_cents": null, "retail_cents": null }]
  }
}
```

```json 404 theme={null}
{
  "error": "Appointment not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.