Добавить новый документ возврата оплаты по сделке продажи
POST/v5/orgs/:org_guid/deals/sales/:deal_guid/docs/money/refunds
Коды возможных ошибок:
[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "Duplicate" - дубликат (объект с таким уникальным идентификатором уже существует) [422]: "NotAllowedForArchived" - операция не разрешена для объектов находящихся в архиве
Request
Path Parameters
Уникальный идентификатор организации
Уникальный иддентификатор сделки продажи
Query Parameters
Possible values: [compact
, full
]
Режим представления результатов запроса
Header Parameters
Язык используемый для ответов
Идентификатор клиента
Possible values: [Unknown
, App
, WebApp
, Service
]
Тип клиента
Имя клиента
ОС клиента
Версия ОС клиента
Разрешение экрана ОС клиента
Модель оборудования клиента
Организация по умолчанию
Поддерживаемые клиентом расширения моделей
- application/json-patch+json
- application/json
- text/json
- application/*+json
Body
Данные нового документа возврата оплаты по сделке продажи
Array [
]
Array [
]
for_payment
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Дата оплаты
sum_by_card
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
sum_by_cash
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
total_sum
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
positions
object[]
nullable
Цели
Оплаченное количество
paid_amount
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
position
object
required
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Тип объекта
fiscal_document
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
transactions
object[]
nullable
Банковские транзакции
Глобальный уникальный идентификатор объекта
Тип объекта
sale
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Possible values: <= 128 characters
Метаданные объекта (нарпимер, идентификатор в сторонней системе)
meta_data
object
nullable
Метаданные объекта в формате ключ-значение
Глобальный уникальный идентификатор объекта
Body
Данные нового документа возврата оплаты по сделке продажи
Array [
]
Array [
]
for_payment
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Дата оплаты
sum_by_card
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
sum_by_cash
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
total_sum
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
positions
object[]
nullable
Цели
Оплаченное количество
paid_amount
object
required
Цена
Значен ие
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
position
object
required
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Тип объекта
fiscal_document
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
transactions
object[]
nullable
Банковские транзакции
Глобальный уникальный идентификатор объекта
Тип объекта
sale
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Possible values: <= 128 characters
Метаданные объекта (нарпимер, идентификатор в сторонней системе)
meta_data
object
nullable
Метаданные объекта в формате ключ-значение
Глобальный уникальный идентификатор объекта
Body
Данные нового документа возврата оплаты по сделке продажи
Array [
]
Array [
]
for_payment
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Дата оплаты
sum_by_card
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
sum_by_cash
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
total_sum
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
positions
object[]
nullable
Цели
Оплаченное количество
paid_amount
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
position
object
required
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Тип объекта
fiscal_document
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
transactions
object[]
nullable
Банковские транзакции
Глобальный уникальный идентификатор объекта
Тип объекта
sale
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Possible values: <= 128 characters
Метаданные объекта (нарпимер, идентификатор в сторонней системе)
meta_data
object
nullable
Метаданные объекта в формате ключ-значение
Глобальный уникальный идентификатор объекта
Body
Данные нового документа возврата оплаты по сделке продажи
Array [
]
Array [
]
for_payment
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Дата оплаты
sum_by_card
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
sum_by_cash
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
total_sum
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
positions
object[]
nullable
Цели
Оплаченное количество
paid_amount
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
position
object
required
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Тип объекта
fiscal_document
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глоб альный уникальный идентификатор объекта
Тип объекта
transactions
object[]
nullable
Банковские транзакции
Глобальный уникальный идентификатор объекта
Тип объекта
sale
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Possible values: <= 128 characters
Метаданные объекта (нарпимер, идентификатор в сторонней системе)
meta_data
object
nullable
Метаданные объекта в формате ключ-значение
Глобальный уникальный идентификатор объекта
Responses
- 201
- 401
- 403
- 404
- 422
- 429
- 500
Created
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Array [
]
for_payment
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Дата оплаты
sum_by_card
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
sum_by_cash
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
total_sum
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
positions
object[]
nullable
Цели
Оплаченное количество
paid_amount
object
required
Цена
Значение
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
Коды валют (ISO 4217)
Тип объекта
position
object
required
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Тип объекта
fiscal_document
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
transactions
object[]
nullable
Банковские транзакции
Глобальный уникальный идентификатор объекта
Тип объекта
sale
object
Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного
типа
Глобальный уникальный идентификатор объекта
Тип объекта
Дата создания
Дата последнего обновления
Дата удаления (архивации)
Possible values: <= 128 characters
Метаданные объекта (нарпимер, идентификатор в сторонней системе)
meta_data
object
nullable
Метаданные объекта в формате ключ-значение
Глобальный уникальный идентификатор объекта
Тип объекта
{
"for_payment": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type_of": "string"
},
"processed_at": "2024-11-18T08:30:51.986Z",
"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-11-18T08:30:51.987Z",
"updated_at": "2024-11-18T08:30:51.987Z",
"deleted_at": "2024-11-18T08:30:51.987Z",
"meta": "string",
"meta_data": {},
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type_of": "string"
}
{
"processed_at": "2024-11-18T08:29:51.5675967Z",
"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": "3d766f0a-3479-4cf7-a11d-e166624dcdf5",
"type_of": "SaleRefund"
}
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"
}