Итоги по номенклатурам
GET/v5/orgs/:org_guid/reports/nomenclature/results
Коды возможных ошибок:
[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию
Request
Path Parameters
GUID организации
Query Parameters
Starting date
End date
Уникальный код
Уникальный код
Токен (курсор, ссылка) запрашиваемой страницы результатов списка. Если он не задан, то возвращается первая страница результатов. Размер страницы списка регулируется сервером.
Possible values: [compact
, full
]
Режим представления результатов запроса
Header Parameters
Язык используемый для ответов
Идентификатор клиента
Possible values: [Unknown
, App
, WebApp
, Service
, Android
]
Тип клиента
Имя клиента
ОС клиента
Версия ОС клиента
Разрешение экрана ОС клиента
Модель оборудования клиента
Организация по умолчанию
Поддерживаемые клиентом расширения моделей
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
items
object[]
nullable
Токен следующей страницы результатов списка
Номер текущей страницы. Если нумерация страниц не поддерживается, принимает значение -1 либо отсутствует. В остальных случаях принимает значения от 1 до total_pages включительно.
общее кол-во страниц (>= 0)
кол-во элементов на странице (постоянное значение с сервера)
общее кол-во элементов списка
Тип объекта
{
"items": [
{
"name": "string",
"sale_price": {
"value": 0,
"currency": "RUB",
"type_of": "string"
},
"uom": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type_of": "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"
}
}
],
"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
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
Extended error message information
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
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
Extended error message information
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
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
Extended error message information
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Client Error
- application/json
- Schema
- Example (from schema)
Schema
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
Extended error message information
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
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
Extended error message information
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Server Error
- application/json
- Schema
- Example (from schema)
Schema
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
Extended error message information
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L 'https://docs.life-pay.ru/v5/orgs/:org_guid/reports/nomenclature/results' \
-H 'Accept: application/json'