Skip to main content

ListRevenueReportsExportTask

GET 
/orgs/:org_guid/async/exports/revenuereports

ListRevenueReportsExportTask

Request​

Path Parameters

    org_guid uuidrequired

Query Parameters

    page_token string
    presentation PresentationModes

    Possible values: [compact, full]

    created_from date-time
    created_to date-time
    updated_from date-time
    updated_to date-time
    order_by AsyncTaskOrdering

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc]

    task_status AsyncTaskStatuses[]

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

Header Parameters

    X-LP-Client-Identifier stringrequired

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

    Example: 6b03359b-6288-4cab-b533-dae76ed6e4bb
    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

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

    Accept-Language stringrequired

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

    Example: en-US

Responses​

Success

Schema

    items

    object[]

    nullable

    items

  • Array [

    • 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_outlet_name

    include_employee_name boolean

    include_employee_name

    include_period_column boolean

    include_period_column

    include_start_column boolean

    include_start_column

    include_end_column boolean

    include_end_column

    include_selection_points_column boolean

    include_selection_points_column

    include_comparison_period_column boolean

    include_comparison_period_column

    include_revenue_column boolean

    include_revenue_column

    include_average_column boolean

    include_average_column

    include_refunds_column boolean

    include_refunds_column

    include_payments_column boolean

    include_payments_column

    include_number_of_payments_column boolean

    include_number_of_payments_column

    include_number_of_refunds_column boolean

    include_number_of_refunds_column

    include_number_of_transactions_column boolean

    include_number_of_transactions_column

    include_median_payments_column boolean

    include_median_payments_column

    filters_for_export

    object

    processed_at_from date-timenullable

    processed_at_from

    processed_at_to date-timenullable

    processed_at_to

    comparison_processed_at_from date-timenullable

    comparison_processed_at_from

    comparison_processed_at_to date-timenullable

    comparison_processed_at_to

    revenueByPeriodsType RevenueByPeriodsType (string)required

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

    outlet_guid uuidnullable

    outlet_guid

    employee_guid uuidnullable

    employee_guid

    status AsyncTaskStatuses (string)

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

    progress int32

    progress

    resolutions

    object[]

    nullable

    resolutions

  • Array [

    • message stringnullable

    message

    type ResolutionTypes (string)

    Possible values: [Information, Warning, Error]

  • ]

    • organization

    object

    guid uuid

    guid

    type_of string

    type_of

    created_at date-time

    created_at

    updated_at date-time

    updated_at

    deleted_at date-timenullable

    deleted_at

    meta stringnullable

    Possible values: <= 128 characters

    meta

    meta_data

    object

    nullable

    meta_data

    property name* string
    guid uuid

    guid

    type_of string

    type_of

  • ]

    • next_page_token stringnullable

    next_page_token

    page_number int32

    page_number

    pages_total int32

    pages_total

    items_per_page int32

    items_per_page

    items_total int32

    items_total

    type_of string

    type_of

Loading...