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

GET /v5/orgs/:org_guid/reports/revenue/outletsperiods

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

[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: 55e7c118-b570-4bb8-a5cf-29ca76f98eb7

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

application/json

Schema
Example (from schema)

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]

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

refunds

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

total

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

type_of stringnullable

Тип объекта

average

object

Суммы в зависимости от типа операции

payments

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

refunds

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

total

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

type_of stringnullable

Тип объекта

median

object

Суммы в зависимости от типа операции

payments

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

refunds

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

total

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

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

Список лементов типа <typeparamref name="T" />

Array [

outlet

object

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

типа

guid uuid

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

type_of stringnullable

Тип объекта

periods

object[]

nullable

Список периодов

Array [

type RevenueByPeriodsType (string)required

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

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

date date-time

Дата начала диапазона

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]

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

refunds

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

total

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

type_of stringnullable

Тип объекта

average

object

Суммы в зависимости от типа операции

payments

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

refunds

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

total

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

type_of stringnullable

Тип объекта

median

object

Суммы в зависимости от типа операции

payments

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

refunds

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

type_of stringnullable

Тип объекта

total

object

Цена

value int64

Значение

currency CurrencyCodes (string)required

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

Коды валют (ISO 4217)

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

Тип объекта

]

type_of stringnullable

Тип объекта

]

next_page_token stringnullable

Токен следующей страницы результатов списка

page_number int32

Номер текущей страницы. Если нумерация страниц не поддерживается, принимает значение -1 либо отсутствует. В остальных случаях принимает значения от 1 до total_pages включительно.

pages_total int32

общее кол-во страниц (>= 0)

items_per_page int32

кол-во элементов на странице (постоянное значение с сервера)

items_total int32

общее кол-во элементов списка

type_of stringnullable

Тип объекта

{
  "for_all_objects": {
    "count": {
      "payments": 0,
      "refunds": 0,
      "total": 0,
      "type_of": "string"
    },
    "sum": {
      "payments": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "refunds": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "total": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "type_of": "string"
    },
    "average": {
      "payments": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "refunds": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "total": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "type_of": "string"
    },
    "median": {
      "payments": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "refunds": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "total": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "type_of": "string"
    },
    "share": {
      "payments": {
        "by_sum": 0,
        "by_count": 0,
        "type_of": "string"
      },
      "refunds": {
        "by_sum": 0,
        "by_count": 0,
        "type_of": "string"
      },
      "total": {
        "by_sum": 0,
        "by_count": 0,
        "type_of": "string"
      },
      "type_of": "string"
    },
    "period": {
      "date_from": "2024-11-18T08:30:53.675Z",
      "date_to": "2024-11-18T08:30:53.675Z",
      "type_of": "string"
    },
    "type_of": "string"
  },
  "items": [
    {
      "outlet": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "periods": [
        {
          "type": "Year",
          "date": "2024-11-18T08:30:53.676Z",
          "summary": {
            "count": {
              "payments": 0,
              "refunds": 0,
              "total": 0,
              "type_of": "string"
            },
            "sum": {
              "payments": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "refunds": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "total": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "type_of": "string"
            },
            "average": {
              "payments": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "refunds": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "total": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "type_of": "string"
            },
            "median": {
              "payments": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "refunds": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "total": {
                "value": 0,
                "currency": "RUB",
                "type_of": "string"
              },
              "type_of": "string"
            },
            "share": {
              "payments": {
                "by_sum": 0,
                "by_count": 0,
                "type_of": "string"
              },
              "refunds": {
                "by_sum": 0,
                "by_count": 0,
                "type_of": "string"
              },
              "total": {
                "by_sum": 0,
                "by_count": 0,
                "type_of": "string"
              },
              "type_of": "string"
            },
            "period": {
              "date_from": "2024-11-18T08:30:53.676Z",
              "date_to": "2024-11-18T08:30:53.676Z",
              "type_of": "string"
            },
            "type_of": "string"
          },
          "type_of": "string"
        }
      ],
      "type_of": "string"
    }
  ],
  "next_page_token": "string",
  "page_number": 0,
  "pages_total": 0,
  "items_per_page": 0,
  "items_total": 0,
  "type_of": "string"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Error codes of HTTP 400 Bad Request state

message stringnullable

Message

info stringnullable

Extended error message information

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

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

/v5/orgs/:org_guid/reports/revenue/outletsperiods

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

Request​

Path Parameters

Query Parameters

Header Parameters

Responses​

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

Request

Responses