Чеки

Атрибут	Значение
Название	info-radar-receipts
Тип	Адаптер для получения чеков
Наименование	Чеки
Версия	Реализовано 21.07.2025

Сервис для получения чеков.

Общая информация

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

Сервис является частью платформы Агредатор. Перед изучением данной документации ознакомьтесь со следующими обязательными документами по интеграции с платформой:

Параметр	Название	Тип	Обязательное	Пример
service	Имя сервиса (всегда `info-radar-receipts`)	string	+	info-radar-receipts
type	Тип запроса	string (enum)	+	list
data	Данные запроса	object	+	см. ниже

Типы запросов type

type	Значение
list	Получить чеки

Структура data

Параметр	Название	Тип	Обязательное	Пример
EntityId	Идентификатор лица	string(uuid)	+	"3fa85f64-5717-4562-b3fc-2c963f66afa6"
EntityType	Тип лица	string	+	"Company"
OrderBy	Сортировка	string	-	"DateDescending"
Page	Номер страницы	integer	-	1

Структура элементов data

EntityId

Описаниe: Идентификатор лица.
Тип данных: string (uuid)
Обязательное: +
Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6

EntityType

Описаниe: Тип лица (Например, компания, физическое лицо и т.п.).
Тип данных: string
Обязательное: +
Пример: Company
Возможные значения: Company, Person, ForeignCompany, Entrepreneur, MunicipalSubject

OrderBy

Описаниe: Параметр сортировки результатов (Например, по дате от меньшего к большему или наоборот).
Тип данных: string
Обязательное: -
Пример: DateDescending

Возможные значения: DateAscending, DateDescending

Page

Описаниe: Номер страницы для постраничного получения данных.
Тип данных: integer
Обязательное: -
Пример: 1

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

Параметр	Название	Обязательное	Тип	Пример
success	Статус запроса	+	string	true
result	Хеш с результатом	-	object	См. ниже
exception	Ошибка	-	string	Что-то пошло не так

Параметры result

Поле	Назначение	Тип	Обязательное	Пример
Aggregations	Агрегационные данные	object	-	Составной элемент Aggregations
TotalItems	Общее число элементов	integer	-	0
Items	Массив из чеков	array[object]	-	Items

Структура элемента `Aggregations`

Поле	Назначение	Тип	Пример
(Например, Status)	Имя агрегационной группы	array[object]	Элемент Aggregations

Элемент массива

Пример json запроса

{
  "service": "info-radar-receipts",
  "type": "list",
  "data": {
    "EntityId": "0316b9a7-35f7-4149-991f-059676b1b4b6",
    "EntityType": "Company"
  }
}

Примеры json ответов

{
  "success": true,
  "result": {
    "Aggregations": {
      "additionalProp1": [
        {
          "Value": "string",
          "Name": "string",
          "Count": 0
        }
      ]
    },
    "TotalItems": 0,
    "Items": [
      {
        "Address": "string",
        "Date": "2025-08-26T11:39:46.994Z",
        "Products": [
          {
            "Name": "string",
            "Price": 0,
            "Count": 0,
            "TotalPrice": 0
          }
        ],
        "Amount": 0
      }
    ]
  }
}

Пример ошибки:

{
  "success": false,
  "exception": "Что-то пошло не так"
}