Skip to main content

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

POST 
/v5/orgs/:org_guid/async/exports/revenueemployeesperiods:new.xlsx

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

Request​

Path Parameters

    org_guid uuidrequired

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

Header Parameters

    Accept-Language stringrequired

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

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

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

    Example: e9160b13-9a42-4160-a4e8-713fd6fe69ab
    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
    processed_at_to date-timenullable
    comparison_processed_at_from date-timenullable
    comparison_processed_at_to date-timenullable
    revenueByPeriodsType RevenueByPeriodsType (string)required

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

    outlet_guid uuidnullable
    employee_guid uuidnullable

Responses​

Success

Schema

    mime_type stringnullable
    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
    processed_at_to date-timenullable
    comparison_processed_at_from date-timenullable
    comparison_processed_at_to date-timenullable
    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

    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...