GetReportMoneyPurposesReportForGoodsWidget

GET 
/orgs/:org_guid/widgets/revenue/goods

GetReportMoneyPurposesReportForGoodsWidget

Request

Path Parameters

org_guid uuidrequired

Query Parameters

current_period_from date-timerequired
current_period_to date-timerequired
previous_period_from date-timerequired
previous_period_to date-timerequired
presentation PresentationModes

Possible values: [compact, full]

max_results int32required

Possible values: >= 1 and <= 10

Header Parameters

X-LP-Client-Identifier stringrequired
ClientIdentifier
Example: 36a733da-662f-42a6-84bf-77712788222b
X-LP-Client-Type stringrequired
Possible values: [Unknown, App, WebApp, Service, Android]
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

X-Client-Extensions csv

ClientDepersonalizedExtensions

Accept-Language stringrequired
Language
Example: en-US

Responses

200

Success

application/json

Schema

Schema

items

object[]

required

items

Array [

uom

object

required

guid uuid

guid

type_of string

type_of

good_name stringrequired

Possible values: non-empty

good_name

current_summary

object

required

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

previous_summary

object

required

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

growth_rate

object

required

percentage int32

percentage

is_calculated boolean

is_calculated

type_of string

type_of

current_quantity doublerequired

current_quantity

previous_quantity doublerequired

previous_quantity

]

type_of string

type_of

Example (from schema)

{
  "items": [
    {
      "uom": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "good_name": "string",
      "current_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": "2025-09-22T12:19:30.639Z",
          "date_to": "2025-09-22T12:19:30.639Z",
          "type_of": "string"
        },
        "type_of": "string"
      },
      "previous_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": "2025-09-22T12:19:30.640Z",
          "date_to": "2025-09-22T12:19:30.640Z",
          "type_of": "string"
        },
        "type_of": "string"
      },
      "growth_rate": {
        "percentage": 0,
        "is_calculated": true,
        "type_of": "string"
      },
      "current_quantity": 0,
      "previous_quantity": 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...