GetReportRevenueByEmployeesPeriodsReportItem

GET 
/orgs/:org_guid/reports/revenue/employeesperiods

GetReportRevenueByEmployeesPeriodsReportItem

Request

Path Parameters

org_guid uuidrequired

Query Parameters

processed_at_from date-time
processed_at_to date-time
revenueByPeriodsType RevenueByPeriodsType

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

outlet_guid uuid[]
employee_guid uuid[]
page_token string
presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired
ClientIdentifier
Example: 0e5800b1-db17-4dc5-ac0e-9398f47dce5a
X-LP-Client-Type stringrequired
Possible values: [Unknown, App, WebApp, Service]
ClientType
Example: App
X-LP-Client-Name string
ClientName
Example: Swagger
X-LP-Client-OS-Name string
ClientOSName
Example: SwaggerDoc
X-LP-Client-OS-Version string
ClientOSVersion
Example: 1.0
X-LP-Client-Screen-Resolution string
ClientScreenResolution
Example: 1280x0900
X-LP-Client-Model string
ClientModel
Example: Chrome 75
X-LP-Organization-Alias string

OrganizationAlias

X-LP-Client-Extensions csv

ClientExtensions

Accept-Language stringrequired
Language
Example: en-US

Responses

200

Success

application/json

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 [

employee

object

guid uuid

guid

type_of string

type_of

periods

object[]

nullable

periods

Array [

type RevenueByPeriodsType (string)required

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

date date-time

date

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

]

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

Example (from schema)

{
  "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:46.606Z",
      "date_to": "2024-11-18T08:30:46.606Z",
      "type_of": "string"
    },
    "type_of": "string"
  },
  "items": [
    {
      "employee": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "periods": [
        {
          "type": "Year",
          "date": "2024-11-18T08:30:46.606Z",
          "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:46.607Z",
              "date_to": "2024-11-18T08:30:46.607Z",
              "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"
}

401

Unauthorized

application/json

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

Example (from schema)

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

403

Forbidden

application/json

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

Example (from schema)

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

404

Not Found

application/json

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

Example (from schema)

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

422

Client Error

application/json

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

Example (from schema)

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

429

Too Many Requests

application/json

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

Example (from schema)

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

500

Server Error

application/json

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

Example (from schema)

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

Loading...