GetReportRevenueByOutletsReportItem

GET /orgs/:org_guid/reports/revenue/outlet

Request

Path Parameters

org_guid uuidrequired

Query Parameters

processed_at_from date-time

processed_at_to date-time

outlet_guid uuid

page_token string

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired

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

Example: b132d21b-db87-402c-be08-3a089fa9814f

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

application/json

Schema
Example (from schema)

Schema

for_all_objects

object

count

object

payments int64

payments

refunds int64

refunds

total int64

total

type_of string

type_of

sum

object

payments

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

refunds

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

total

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

type_of string

type_of

average

object

payments

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

refunds

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

total

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

type_of string

type_of

median

object

payments

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

refunds

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

total

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

type_of string

type_of

share

object

payments

object

by_sum double

by_sum

by_count double

by_count

type_of string

type_of

refunds

object

by_sum double

by_sum

by_count double

by_count

type_of string

type_of

total

object

by_sum double

by_sum

by_count double

by_count

type_of string

type_of

type_of string

type_of

period

object

date_from date-time

date_from

date_to date-time

date_to

type_of string

type_of

type_of string

type_of

items

object[]

nullable

items

Array [

outlet

object

guid uuid

guid

type_of string

type_of

summary

object

count

object

payments int64

payments

refunds int64

refunds

total int64

total

type_of string

type_of

sum

object

payments

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

refunds

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

total

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

type_of string

type_of

average

object

payments

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

refunds

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

total

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

type_of string

type_of

median

object

payments

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

refunds

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

total

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

type_of string

type_of

share

object

payments

object

by_sum double

by_sum

by_count double

by_count

type_of string

type_of

refunds

object

by_sum double

by_sum

by_count double

by_count

type_of string

type_of

total

object

by_sum double

by_sum

by_count double

by_count

type_of string

type_of

type_of string

type_of

period

object

date_from date-time

date_from

date_to date-time

date_to

type_of string

type_of

type_of string

type_of

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

{
  "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-10-23T06:47:41.486Z",
      "date_to": "2024-10-23T06:47:41.486Z",
      "type_of": "string"
    },
    "type_of": "string"
  },
  "items": [
    {
      "outlet": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "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-10-23T06:47:41.486Z",
          "date_to": "2024-10-23T06:47:41.486Z",
          "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]

message stringnullable

message

info stringnullable

info

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

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

GetReportRevenueByOutletsReportItem

/orgs/:org_guid/reports/revenue/outlet

Request​

Path Parameters

Query Parameters

Header Parameters

Responses​

Request

Responses