Skip to main content

Добавляет новую асинхронную задачу на экспорт выручки по периодам по выручке в CSV.

POST 
/v5/orgs/:org_guid/async/exports/revenueperiods:new.csv

Добавляет новую асинхронную задачу на экспорт выручки по периодам по выручке в CSV.

Request​

Path Parameters

    org_guid uuidrequired

    Уникальный идентификатор организации

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: c5d2abf4-1bbd-4b3a-814a-6fcb64fe3a91
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Body

Параметры экспорта

    attributes_for_export

    object

    Представляет собой набор флагов (Да/Нет), через которые настраивается то, значения каких атрибутов сущностей участвующих в экспорте отчетов по выручке должны быть включены в экспортируемый файл.

    include_outlet_name boolean

    Добавить наименование торговой точки

    include_employee_name boolean

    Добавить наименование сотрудника

    include_period_column boolean

    Добавить данные периода отчета

    include_start_column boolean

    Добавить данные начала периода

    include_end_column boolean

    Добавить данные окончания периода

    include_selection_points_column boolean

    Добавить данные для точечной выборки данных

    include_comparison_period_column boolean

    Добавить данные периода для сравнения

    include_revenue_column boolean

    Добавить данные по выручке

    include_average_column boolean

    Добавить данные по среднему чеку

    include_refunds_column boolean

    Добавить данные по сумме возвратов

    include_payments_column boolean

    Добавить данные по сумме оплат

    include_number_of_payments_column boolean

    Добавить данные по количеству оплат

    include_number_of_refunds_column boolean

    Добавить данные по количеству возвратов

    include_number_of_transactions_column boolean

    Добавить данные по количеству операций

    include_median_payments_column boolean

    Добавить данные по медианному значению оплат

    filters_for_export

    object

    Параметры фильтров для экспорта отчетов по выручке

    processed_at_from date-timenullable

    Starting date

    processed_at_to date-timenullable

    End date

    comparison_processed_at_from date-timenullable

    Starting date 2

    comparison_processed_at_to date-timenullable

    End date 2

    revenueByPeriodsType RevenueByPeriodsType (string)required

    Possible values: [Year, Quarter, Month, Week, Day, Hour]

    Типы периодов

    outlet_guid uuidnullable

    Уникальный код торговой точки

    employee_guid uuidnullable

    Уникальный код сотрудника

Responses​

Success

Schema

    mime_type stringnullable

    mime_type

    report_export_type ReportExportType (string)required

    Possible values: [RevenueByPeriodsExcel, RevenueByOutletsPeriodsExcel, RevenueByEmploeesPeriodsExcel, RevenueByPeriodsCSV, RevenueByOutletsPeriodsCSV, RevenueByEmploeesPeriodsCSV, ReportTransactionExcel, ReportTransactionCSV, ReportFiscalDocumentExcel, ReportFiscalDocumentCSV, ReportMoneyOperationExcel, ReportMoneyOperationCSV, ReportPaymentAndRefundExcel, ReportPaymentAndRefundCSV, ReportCombinedExcel, ReportCombinedCSV, ReportNomenclatureResultExcel, ReportNomenclatureResultCSV]

    Перечисление типов выгружаемых отчетов с выручками

    parameters

    object

    Параметры экспорта отчета по выручке

    attributes_for_export

    object

    Представляет собой набор флагов (Да/Нет), через которые настраивается то, значения каких атрибутов сущностей участвующих в экспорте отчетов по выручке должны быть включены в экспортируемый файл.

    include_outlet_name boolean

    Добавить наименование торговой точки

    include_employee_name boolean

    Добавить наименование сотрудника

    include_period_column boolean

    Добавить данные периода отчета

    include_start_column boolean

    Добавить данные начала периода

    include_end_column boolean

    Добавить данные окончания периода

    include_selection_points_column boolean

    Добавить данные для точечной выборки данных

    include_comparison_period_column boolean

    Добавить данные периода для сравнения

    include_revenue_column boolean

    Добавить данные по выручке

    include_average_column boolean

    Добавить данные по среднему чеку

    include_refunds_column boolean

    Добавить данные по сумме возвратов

    include_payments_column boolean

    Добавить данные по сумме оплат

    include_number_of_payments_column boolean

    Добавить данные по количеству оплат

    include_number_of_refunds_column boolean

    Добавить данные по количеству возвратов

    include_number_of_transactions_column boolean

    Добавить данные по количеству операций

    include_median_payments_column boolean

    Добавить данные по медианному значению оплат

    filters_for_export

    object

    Параметры фильтров для экспорта отчетов по выручке

    processed_at_from date-timenullable

    Starting date

    processed_at_to date-timenullable

    End date

    comparison_processed_at_from date-timenullable

    Starting date 2

    comparison_processed_at_to date-timenullable

    End date 2

    revenueByPeriodsType RevenueByPeriodsType (string)required

    Possible values: [Year, Quarter, Month, Week, Day, Hour]

    Типы периодов

    outlet_guid uuidnullable

    Уникальный код торговой точки

    employee_guid uuidnullable

    Уникальный код сотрудника

    status AsyncTaskStatuses (string)

    Possible values: [InQueue, InProgress, WaitingForFeedback, Completed, Canceled]

    Перечисляет статусы в которых может находиться любая асинхронная задача.

    progress int32

    Прогресс

    resolutions

    object[]

    nullable

    Резолюции

  • Array [

    • message stringnullable

    Сообщения

    type ResolutionTypes (string)

    Possible values: [Information, Warning, Error]

  • ]

    • organization

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    created_at date-time

    Дата создания

    updated_at date-time

    Дата последнего обновления

    deleted_at date-timenullable

    Дата удаления (архивации)

    meta stringnullable

    Possible values: <= 128 characters

    Метаданные объекта (нарпимер, идентификатор в сторонней системе)

    meta_data

    object

    nullable

    Метаданные объекта в формате ключ-значение

    property name* string
    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

Loading...