Полный или частичный возврат

Обновлено 14 февраля 2025

PATCH

/invoices/{invoice_id}

Инициатор присылает запрос на возврат, полный или частичный. Счет должен находиться в состоянии 0 «Оплачен». Запрос можно выполнять несколько раз, вплоть до полного возврата. Если произведен полный возврат, то счет переходит в состояние 7 «Возвращен»

Запрос

Path Parameters

invoice_id

string

required

ID счета

Header Parameters

author

string

Пользователь, который производит изменения

• application/json

Body

Инфо об отмене счета. В частности, отменяемая сумма и корзина возврата

invoice object

Корзина возврата

order objectrequired

Данные заказа для возврата

current_amount

integer

required

Текущая сумма счета, в копейках, без разделителей.

Например, 123р.00коп. = 12300

refund_amount

integer

required

Сумма возврата, в копейках, без разделителей.

Например, 123р.00коп. = 12300

currency

string

Код валюты в формате ISO 4217.

Поддерживается только значение RUB

order_bundle

object[]

required

Состав заказа (элементы корзины)

Ответы

• 200
• 400
• 401
• default

Возврат произведен

• application/json

• Схема
• Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

bad input parameter

• application/json

• Схема
• Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Access token is missing or invalid

Unexpected error

• application/json

• Схема
• Пример из схемы

Schema

error object

user_message

string

Сообщение для пользователя

error_description

string

Техническое описание ошибки

error_code

string

Код ответа

{
  "error": {
    "user_message": "",
    "error_description": "",
    "error_code": "0"
  }
}

Loading...

Loading...