Перейти к основному содержимому
Версия: LIFE POS 5.0

Отчёты

LIFE POS предоставляет подробные отчёты: по выручке, продажам, транзакциям, фискальным документам и т. д. Их можно посмотреть и скачать в личном кабинете (ЛК) LIFE POS, настроив период — например, квартал или полугодие.

Если отчёты нужны вам регулярно за один и тот же период, проще настроить автоматическую выгрузку по API. Вы можете выгружать их в таблице Excel или в формате CSV, а также в различных срезах.

Если файлы отчётов не подходят, или если нужно поменять представление, — получите данные отчётов по API и создайте свой интерфейс для работы с ними. Рассказываем, как это сделать.

Для передачи файлов используется тип данных multipart/form-data.

Как работать с multipart

Выручка за период​

Чтобы получить файл отчёта, сперва нужно создать задачу на экспорт. Если экспортируете отчёт в таблицу Excel, создайте задачу POST-запросом по адресу:

{base_url}/v5/orgs/{org_guid}/async/exports/revenueperiods:new.xlsx

base_url — адрес сервиса. Возможные значения:

  • https://api-dev.life-pos.ru — тестовый API,
  • https://api.life-pos.ru — рабочий API.

Описание запроса Excel

Описание запроса CSV

Чтобы получить данные отчёта, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/reports/revenue/periods

Описание запроса

Выручка с группировкой по точкам​

Отчёт нужен, чтобы сравнивать торговые точки по выручке между собой. В той точке, где выручки больше, можно увеличить сотрудникам план продаж, и наоборот.

{base_url}/v5/orgs/{org_guid}/async/exports/revenueoutletsperiods:new.xlsx

Адреса сервиса

Описание запроса Excel

Описание запроса CSV

Получить данные отчёта можно GET-запросом. Доступны две структуры данных — с группировкой по точкам и одноуровневым списком.

{base_url}/v5/orgs/{org_guid}/reports/revenue/outletsperiods

Описание запроса с группировкой

Описание запроса одноуровневым списком

Описание запроса итогов

Выручка с группировкой по курьерам​

Отчёт нужен для построения индивидуальных планов мотивации. Вы увидите, кто из курьеров принёс больше выручки, и сможете поощрять отличившихся.

{base_url}/v5/orgs/{org_guid}/async/exports/revenueemployeesperiods:new.xlsx

Адреса сервиса

Описание запроса Excel

Описание запроса CSV

Чтобы получить данные отчёта, отправьте GET-запрос. Доступны две структуры данных по периодам — с группировкой по курьерам и одноуровневым списком, а также итоговый отчёт по курьерам.

{base_url}/v5/orgs/{org_guid}/reports/revenue/employeesperiods

Описание запроса с группировкой

Описание запроса одноуровневым списком

Описание запроса итогов

Выручка по позициям​

Этот отчёт показывает, сколько единиц каждого товара было продано и по какой цене. Используйте его, чтобы узнать, сколько товара осталось и какие товары продаются лучше всего.

{base_url}/v5/orgs/{org_guid}/async/exports/nomenclature/results:new.xlsx

Адреса сервиса

Описание запроса Excel

Описание запроса CSV

Чтобы получить данные отчёта, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/reports/nomenclature/results

Описание запроса

Продажи​

В этом отчёте перечислены продажи: кто купил, у кого, кто оформил сделку, когда, по какой цене, с какой скидкой и в каком статусе находятся оплата и отгрузка товара. Пригодится для учёта продаж.

{base_url}/v5/orgs/{org_guid}/async/exports/reportmoneys:new.xlsx

Адреса сервиса

Описание запроса Excel

Описание запроса CSV

Чтобы получить данные отчёта, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/reports/operation/money

Описание запроса

Транзакции​

Содержит данные всех ваших банковских транзакций и переводов по СБП.

{base_url}/v5/orgs/{org_guid}/async/exports/reporttransactions:new.xlsx

Адреса сервиса

Описание запроса Excel

Описание запроса CSV

Чтобы получить данные отчёта, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/reports/operation/transaction

Описание запроса

Фискальные документы​

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

{base_url}/v5/orgs/{org_guid}/async/exports/reportfiscals:new.xlsx

Адреса сервиса

Описание запроса Excel

Описание запроса CSV

Чтобы получить данные отчёта, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/reports/operation/fiscal

Описание запроса

Платежи и возвраты​

Этот отчёт показывает движение денежных средств в разрезе платежей от клиентов и возвратов.

{base_url}/v5/orgs/{org_guid}/async/exports/reportpaymentsrefunds:new.xlsx

Адреса сервиса

Описание запроса Excel

Описание запроса CSV

Чтобы получить данные отчёта, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/reports/operation/paymentrefund

Описание запроса

Получить данные задачи​

Вы можете получить список всех задач на экспорт. Если вам нужны задачи на экспорт отчётов по выручке, отправьте GET-запрос. Адрес подходит для базового отчёта по выручке, а также отчётов с группировкой по точкам и по сотрудникам, но не по позициям.

{base_url}/v5/orgs/{org_guid}/async/exports/revenuereports

Адреса сервиса

Описание запроса

Если нужны задачи на экспорт остальных отчётов, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/async/exports/operationsreports

Описание запроса

Данные выводятся постранично, по 20 записей на страницу. Если нужно получить данные второй страницы, возьмите из ответа значение параметра next_page_token и отправьте новый запрос, передав это значение в параметре page_token. Продолжайте до тех пор, пока параметр next_page_token не придёт пустым.

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

“next_page_token”: “OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”,
“page_number”: 1,
“pages_total”: 2,
“items_per_page”: 20,
“items_total”: 27,

В ответе представлены только записи 1–20. Чтобы посмотреть записи с 21 по 27, отправьте новый GET-запрос, указав page_token=“OdDEFa2CzpYdp1CmlO9s9mjBn4NkUZB3CXKOtNfQWM0”.

Важно

В запросе есть необязательный параметр selection. Это фильтр задач по их статусу. Если параметр не передан, по умолчанию используется значение alive_only, то есть в ответе придут только данные задач, не перенесённых в архив. Чтобы посмотреть весь список задач или только архивные данные, укажите значение all или archived_only соответственно.

Также вы можете посмотреть данные конкретной задачи. Действует то же разделение: если экспортируете отчёт о выручке, в т. ч. с группировкой, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/async/exports/revenuereports/{task_guid}

task_guid — идентификатор задачи. Если вы не указали его при создании, LIFE POS создал его сам. Тогда его можно получить, запросив список задач на экспорт.

Описание запроса

Если экспортируете любой из остальных отчётов, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/async/exports/operationsreports/{task_guid}

Описание запроса

Следите за статусом задачи. Вот список статусов:

  • InQueue — в очереди,
  • InProgress — в работе,
  • WaitingForFeedback — требуется обратная связь,
  • Completed — отчёт готов,
  • Canceled — задача отменена.

Скачать файл отчёта​

Когда задача перейдёт в статус Completed, файл отчёта можно будет скачать.

Чтобы скачать отчёт о выручке, отправьте GET-запрос. Адрес подходит для скачивания базового отчёта по выручке, а также отчётов с группировкой по точкам и по сотрудникам, но не по позициям.

{base_url}/v5/orgs/{org_guid}/async/exports/revenuereports/{task_guid}/result.xlsx

Адреса сервиса

  • task_guid — идентификатор задачи. Если вы не указали его при создании, LIFE POS создал его сам. Тогда его можно получить, запросив список задач на экспорт.

Описание запроса Excel

Описание запроса CSV

Чтобы скачать остальные отчёты, отправьте GET-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/async/exports/operationsreports/{task_guid}/result.xlsx

Описание запроса Excel

Описание запроса CSV

Отменить экспорт​

Чтобы отменить задачу на экспорт отчётов о выручке, отправьте POST-запрос. Адрес подходит для отмены базового отчёта по выручке, а также отчётов с группировкой по точкам и по сотрудникам, но не по позициям.

{base_url}/v5/orgs/{org_guid}/async/exports/revenuereports/{task_guid}:cancel

Адреса сервиса

  • task_guid — идентификатор задачи. Если вы не указали его при создании, LIFE POS создал его сам. Тогда его можно получить, запросив список задач на экспорт.

Описание запроса

Чтобы отменить задачу на экспорт остальных отчётов, отправьте POST-запрос по адресу:

{base_url}/v5/orgs/{org_guid}/async/exports/operationsreports/{task_guid}:cancel

Описание запроса

Вот и всё. В следующей статье поговорим об экспорте отчётов по операциям.