receipt_longReceipt. Продажи

Метод возвращает чеки продаж и возвратов вместе со строками, оплатой и данными о кассе. Чеки можно только читать: создаются они кассовым приложением. Выгрузку можно вести по датам либо по маркеру — так удобно получать только новые чеки после прошлого обмена.

Все параметры, кроме ключа apikey и формата format, принимаются и в адресной строке, и в теле POST.

GET https://[компания].myvirtualpos.ru/api/receipt?apikey=MySecret&datefrom=20260901&dateto=20260902&warehouseid=8

Чеки возвращаются по возрастанию ид. В выгрузку попадают только фискальные чеки: с типом «продажа» или «возврат» (и операции покупки у клиента) и с заполненным регистрационным номером фискального регистратора.

Каждый чек содержит поле marker вида 1780236802:0000386289. Запомните маркер последнего обработанного чека и передайте его в параметре marker в следующем запросе: ответ будет содержать только чеки, которые появились или были изменены после него. Так ничего не теряется и не приходят повторы.

Маркер состоит из двух чисел: времени последнего изменения чека и ид чека. Оба обязательны, ид не может быть просто 0. Для первой выгрузки используйте даты, а маркер берите из полученных чеков.

Через двоеточие можно перечислить:

Если указано неизвестное поле, метод вернёт ошибку со списком допустимых значений.

Пустые значения в JSON приходят как null, в XML — как пустой элемент.

Основное

Касса и кассир

Оплата

Дополнительные блоки

{
  "success": 1,
  "type": "receipt",
  "count": 1,
  "receipts": [
    {
      "receipt": {
        "receipt_id": "57307ECE-1489-4B1F-A3AE-3F4E5CDC0BF1",
        "marker": "1780232425:0000386281",
        "terminalid": "100000032",
        "warehouseid": 8,
        "user_id": 3,
        "corp_code": "",
        "fr_session": 10,
        "doc_type": "sale",
        "doc_num": 23,
        "doc_num_session": 15,
        "date": "31.05.2026 16:00:23",
        "discount": "0.00",
        "discount_misc": "0.00",
        "amount": "150.00",
        "round_amount": "0.00",
        "pay_cash": "0.00",
        "pay_card": "150.00",
        "pay_tare": "0.00",
        "pay_credit": "0.00",
        "pay_sbp": "0.00",
        "pay_bonus_id": null,
        "pay_bonus_amount": "0.00",
        "pinpad_name": "standalone",
        "terminal_number": 2,
        "short_fiscal_serial_number": "000003",
        "device_model_name": "",
        "device_model_version": "",
        "terminal_description": "Касса № 2",
        "is_electronic": 0,
        "fiscal_attribute": null,
        "vat10_sum": "0.00",
        "vat18_sum": "0.00",
        "vat20_sum": "0.00",
        "items_count": 1,
        "items": [
          {
            "item": {
              "line_id": "CEDC9509-633B-5B89-7F57-B56588767BFA",
              "itemid": 4620,
              "quantity": "1.000",
              "pricebase": "150.00",
              "pricesale": "150.0000",
              "discount": "0.00",
              "amount": "150.00",
              "barcode": null,
              "cogs": "0.00",
              "user_id": null,
              "vat_applied": "-1.00",
              "vat_amount": "0.00",
              "onhand_id": 81540
            }
          }
        ]
      }
    }
  ]
}

Тот же ответ при format=xml (сокращённо):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>receipt</type>
  <count>1</count>
  <receipts>
    <receipt>
      <receipt_id>57307ECE-1489-4B1F-A3AE-3F4E5CDC0BF1</receipt_id>
      <marker>1780232425:0000386281</marker>
      <doc_type>sale</doc_type>
      <amount>150.00</amount>
      <!-- остальные поля чека -->
      <items_count>1</items_count>
      <items>
        <item>
          <line_id>CEDC9509-633B-5B89-7F57-B56588767BFA</line_id>
          <itemid>4620</itemid>
          <quantity>1.000</quantity>
          <!-- остальные поля строки -->
        </item>
      </items>
    </receipt>
  </receipts>
</root>

Ошибка авторизации и общие ошибки описаны в статье Общие сведения.

Если по условиям ничего не найдено, метод возвращает успешный ответ с count равным 0 и пустым списком receipts.