Перейти к содержимому
СервисАпп API
На этой странице

Карточка — HTTP 200

Поля вложенного объекта обязательны только при наличии этого объекта. Поля с null=да принимают или возвращают явный null. Необязательные поля могут отсутствовать из-за прав.

Поле Тип Обязательно null Ограничения и смысл
data объект да нет —
data.id целое число да нет —
data.product_id целое число да нет —
data.quantity строка да нет —
data.unit_id целое число да нет —
data.unit_price объект да нет —
data.unit_price.amount строка да нет —
data.unit_price.currency строка да нет —
data.discount объект да нет —
data.discount.amount строка да нет —
data.discount.currency строка да нет —
data.markup_id целое число / null да да —
data.serial_number строка / null да да —
data.note строка / null да да —
data.maintenance_schedule_id целое число / null да да —
data.equipment_id целое число / null да да —
data.reservation_state строка да нет —
data.inventory_effect объект да нет —
data.inventory_effect.mode строка да нет —
data.inventory_effect.reserved_quantity строка да нет —
data.inventory_effect.written_off_quantity строка да нет —
data.inventory_effect.shortage_quantity строка да нет —
data.inventory_effect.requires_reconciliation логическое значение да нет —
data.version строка да нет —
data.updated_at строка / null да да —
meta объект да нет —

Пример формы ответа

Все значения демонстрационные. Идентификаторы связей и доступные ссылки определяет организация.

{
  "data": {
    "id": 101,
    "product_id": 101,
    "quantity": "1.00",
    "unit_id": 101,
    "unit_price": {
      "amount": "1.00",
      "currency": "RUB"
    },
    "discount": {
      "amount": "1.00",
      "currency": "RUB"
    },
    "markup_id": null,
    "serial_number": null,
    "note": null,
    "maintenance_schedule_id": null,
    "equipment_id": null,
    "reservation_state": "пример",
    "inventory_effect": {
      "mode": "пример",
      "reserved_quantity": "пример",
      "written_off_quantity": "пример",
      "shortage_quantity": "пример",
      "requires_reconciliation": true
    },
    "version": "1793782800",
    "updated_at": null
  },
  "meta": {}
}