Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-payments/delete.md индекс документации — /llms.txt

Удалить оплату CRM

DELETE /v1/crm-payments/:id

Удаляет оплату CRM без отметки «оплачена» вместе с её позициями, количество товаров из них снова становится доступным для оплат. Восстановить удалённую оплату через API нельзя — при необходимости создайте новую.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID оплаты. Список оплат объекта: GET /v1/crm-payments

Примеры

curl — личный ключ

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/crm-payments/567" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/crm-payments/567" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-payments/567', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

if (res.status === 204) {
  console.log('Оплата удалена')
}

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-payments/567', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

if (res.status === 204) {
  console.log('Оплата удалена')
}

Ответ

При успешном удалении возвращается HTTP-статус 204 No Content с пустым телом — успех проверяется по статусу.

Пример ответа

http 
HTTP/1.1 204 No Content

Пример ответа при ошибке

404 — оплаты с таким ID нет, в том числе уже удалённой:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Payment has not been found"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Оплаты с таким id нет, в том числе уже удалённой
422 BITRIX_ERROR У оплаты стоит отметка «оплачена» — error.b24Code равен SALE_PAYMENT_DELETE_EXIST_PAID. Сначала снимите отметку через POST /v1/crm-payments/:id/unpay
422 BITRIX_ERROR Битрикс24 отклонил запрос, причина — в error.message
422 BITRIX_NO_EFFECT Битрикс24 не подтвердил удаление
400 INVALID_ID id не положительное целое число
403 BITRIX_ACCESS_DENIED У пользователя ключа нет доступа к объекту CRM или оплате в Битрикс24
403 WRITE_BLOCKED_READONLY_KEY Ключу запрещена запись
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
401 MISSING_API_KEY Не передан X-Api-Key

Полный список общих ошибок API — Ошибки.

Известные особенности

После удаления количество товаров снова доступно для оплат. Количество, которое было в позициях удалённой оплаты, снова видно в доступных товарных строках и может войти в новую оплату.

Смотрите также