Skip to main content

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

GET 

/v5/orgs/:org_guid/reports/revenue/employeesandperiods

Коды возможных ошибок:

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию

Request

Path Parameters

    org_guid uuidrequired

    GUID организации

Query Parameters

    processed_at_from date-time

    Starting date

    processed_at_to date-time

    End date

    revenueByPeriodsType RevenueByPeriodsType

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

    Perion type

    outlet_guid uuid

    Уникальный код

    employee_guid uuid

    Уникальный код

    page_token string
    presentation PresentationModes

    Possible values: [compact, full]

Header Parameters

    Accept-Language stringrequired

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

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

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

    Example: b177ac16-fa1f-4348-8639-705041b3cde9
    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

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

Responses

Success

Schema

    for_all_objects

    object

    count

    object

    payments int64
    refunds int64
    total int64
    type_of stringnullable

    sum

    object

    payments

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    refunds

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    total

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable
    type_of stringnullable

    average

    object

    payments

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    refunds

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    total

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable
    type_of stringnullable

    median

    object

    payments

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    refunds

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    total

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable
    type_of stringnullable

    share

    object

    payments

    object

    by_sum double
    by_count double
    type_of stringnullable

    refunds

    object

    by_sum double
    by_count double
    type_of stringnullable

    total

    object

    by_sum double
    by_count double
    type_of stringnullable
    type_of stringnullable

    period

    object

    date_from date-time
    date_to date-time
    type_of stringnullable
    type_of stringnullable

    items

    object[]

    nullable

  • Array [

  • type RevenueByPeriodsType (string)required

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

    date date-time

    employee

    object

    guid uuid
    type_of stringnullable

    summary

    object

    count

    object

    payments int64
    refunds int64
    total int64
    type_of stringnullable

    sum

    object

    payments

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    refunds

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    total

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable
    type_of stringnullable

    average

    object

    payments

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    refunds

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    total

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable
    type_of stringnullable

    median

    object

    payments

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    refunds

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable

    total

    object

    value int64
    currency CurrencyCodes (string)required

    Possible values: [RUB, GBP, USD, EUR, Unknown]

    type_of stringnullable
    type_of stringnullable

    share

    object

    payments

    object

    by_sum double
    by_count double
    type_of stringnullable

    refunds

    object

    by_sum double
    by_count double
    type_of stringnullable

    total

    object

    by_sum double
    by_count double
    type_of stringnullable
    type_of stringnullable

    period

    object

    date_from date-time
    date_to date-time
    type_of stringnullable
    type_of stringnullable
    type_of stringnullable
  • ]

  • next_page_token stringnullable
    page_number int32
    pages_total int32
    items_per_page int32
    items_total int32
    type_of stringnullable
Loading...