Это старая версия документа.


API :: CashFlow. Движение денежных средств на кассе

В системе реализован программный интерфейс для получения данных движении денежных средств на кассовом рабочем месте. Данные выгружаются по http протоколу. Формат на выбор - xml или json.

Доступны данные о следующих типах операций:

  • sale - поступление наличных денег от продажа товара
  • return - выплата за возврат товара на кассе
  • collection - инкассация
  • outcome - выплата наличных денег из кассы
  • income - внесение наличных денег в кассу

Получение данных

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

http://mycompany.virtpos.ru/api/cashflow?apikey=MySecret&days=2

Параметры запроса данных:

  • int terminalid - ID кассы. Если не указан, то будут отданы данные по всем кассам
  • int warehouseid - ID точки продаж (магазина), данные о которой надо получить. Будут отданы данные обо всех кассах этого магазина. Параметр игнорируется, если указан terminalid
  • string warehouseextid - ID точки продаж во внешней системе (например, в 1С). Параметр игнорируется, если указан terminalid или warehouseid
  • string type - типы операций, которые надо вернуть. Полный перечень типов указан выше. Если необходимо вернуть данные о нескольких типах сразу, то можно указать их через запятую. Пример: income,outcome,collection
  • int lastid - если указан, то возвращаются все денежные транзакции, которые были после указанного lastId. Используется для получения только новых данных с момента последнего обращения
  • int limit - возвращает не более указанного количества записей. По умолчанию установлен лимит 100 записей
  • int days - возвращает данные за последние количество дней.