Получить данные документа возврата оплаты по сделке продажи

GET /v5/orgs/:org_guid/deals/sales/:deal_guid/docs/money/refunds/:doc_guid

Коды возможных ошибок:

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены

Важная информация!

Если указанный объект удален (помещен в архив) данный метод всё равно вернет данные по нему.

Request

Path Parameters

org_guid uuidrequired

Уникальный идентификатор организации

deal_guid anyrequired

Уникальный иддентификатор сделки продажи

doc_guid uuidrequired

Уникальный идентификатор документа возврата оплаты по сделке продажи

Query Parameters

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

Accept-Language stringrequired

Язык используемый для ответов

Example: ru-RU

X-LP-Client-Identifier stringrequired

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

Example: 8bf203fc-8ae6-48a9-ac55-e1b46fd8ac80

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

Поддерживаемые клиентом расширения моделей

Responses

Success

application/json

Schema
Example (from schema)
Example

Schema

for_payment

object

guid uuid

type_of stringnullable

processed_at date-timerequired

sum_by_card

object

required

value int64

currency CurrencyCodes (string)required

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

type_of stringnullable

sum_by_cash

object

required

value int64

currency CurrencyCodes (string)required

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

type_of stringnullable

total_sum

object

required

value int64

currency CurrencyCodes (string)required

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

type_of stringnullable

positions

object[]

nullable

Array [

paid_quantity doublerequired

paid_amount

object

required

value int64

currency CurrencyCodes (string)required

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

type_of stringnullable

position

object

required

guid uuid

type_of stringnullable

]

fiscal_document

object

guid uuid

type_of stringnullable

transactions

object[]

nullable

Array [

guid uuid

type_of stringnullable

]

sale

object

guid uuid

type_of stringnullable

created_at date-time

updated_at date-time

deleted_at date-timenullable

meta stringnullable

Possible values: <= 128 characters

meta_data

object

nullable

property name* string

guid uuid

type_of stringnullable

{
  "for_payment": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "processed_at": "2024-10-23T06:47:46.856Z",
  "sum_by_card": {
    "value": 0,
    "currency": "RUB",
    "type_of": "string"
  },
  "sum_by_cash": {
    "value": 0,
    "currency": "RUB",
    "type_of": "string"
  },
  "total_sum": {
    "value": 0,
    "currency": "RUB",
    "type_of": "string"
  },
  "positions": [
    {
      "paid_quantity": 0,
      "paid_amount": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "position": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "type_of": "string"
    }
  ],
  "fiscal_document": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "transactions": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type_of": "string"
    }
  ],
  "sale": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "created_at": "2024-10-23T06:47:46.856Z",
  "updated_at": "2024-10-23T06:47:46.856Z",
  "deleted_at": "2024-10-23T06:47:46.856Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type_of": "string"
}

{
  "processed_at": "2024-04-24T11:15:53.1340518Z",
  "sum_by_card": {
    "value": 10000,
    "currency": "RUB",
    "type_of": "Money"
  },
  "sum_by_cash": {
    "value": 2000,
    "currency": "RUB",
    "type_of": "Money"
  },
  "total_sum": {
    "value": 12000,
    "currency": "RUB",
    "type_of": "Money"
  },
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "guid": "5d3a0e6e-d88c-4220-91b4-5e34e35668d1",
  "type_of": "SaleRefund"
}

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

info stringnullable

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

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

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

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

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

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

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

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

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

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

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

Получить данные документа возврата оплаты по сделке продажи

/v5/orgs/:org_guid/deals/sales/:deal_guid/docs/money/refunds/:doc_guid

Коды возможных ошибок:​

Важная информация!​

Request​

Path Parameters

Query Parameters

Header Parameters

Responses​

Коды возможных ошибок:

Важная информация!

Request

Responses