GetReportReportNomenclatureBalanceResultItem

GET 
/orgs/:org_guid/reports/nomenclature/balance/results

GetReportReportNomenclatureBalanceResultItem

Request

Path Parameters

org_guid uuidrequired

Query Parameters

date_from date-time
good_category_guid uuid[]
outlet_guid uuid
warehouse_guid uuid
balance_type ReportNomenclatureBalanceType

Possible values: [FromValue, ToValue, Zero, LessZero]

balance_value double
page_token string
presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired
ClientIdentifier
Example: 3ae3a77c-b26e-4351-a329-3fa6b97ee55e
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

X-Client-Extensions csv

ClientDepersonalizedExtensions

Accept-Language stringrequired
Language
Example: en-US

Responses

200

Success

application/json

Schema

Schema

items

object[]

nullable

items

Array [

category stringnullable

category

name stringnullable

name

quantity_payment double

quantity_payment

quantity_refund double

quantity_refund

revenue_amount

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

refund_amount

object

value int64

value

currency CurrencyCodes (string)required

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

type_of string

type_of

balance double

balance

average_consumption double

average_consumption

sale_days int32

sale_days

]

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)

{
  "items": [
    {
      "category": "string",
      "name": "string",
      "quantity_payment": 0,
      "quantity_refund": 0,
      "revenue_amount": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "refund_amount": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "balance": 0,
      "average_consumption": 0,
      "sale_days": 0
    }
  ],
  "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...