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

Снять с оплаты CRM отметку «оплачена»

POST /v1/crm-payments/:id/unpay

Снимает с оплаты CRM отметку «оплачена», например перед удалением: оплату с отметкой удалить нельзя. Снятие отметки, как и её установка, может запустить автоматизации портала.

Параметры

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

Тело запроса не передаётся либо передаётся {}.

Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/crm-payments/565/unpay" \
  -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/565/unpay', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { data } = await res.json()
console.log(`Оплата ${data.accountNumber}, отметка: ${data.paid}`)

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

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

const { data } = await res.json()

Поля ответа

Возвращается оплата после снятия отметки.

Поле Тип Описание
success boolean true при успехе
data object Объект оплаты. Ключевые поля оплаты — на странице Оплаты CRM
data.id number ID оплаты
data.accountNumber string Номер оплаты: номер связанного заказа и порядковый номер оплаты через /
data.paid string N — отметка снята
data.datePaid string | null Время последней отметки «оплачена», ISO 8601 со смещением часового пояса. Снятие отметки его не очищает
data.empPaidId number | null ID сотрудника, который последним отметил оплату. Снятие отметки его не очищает. Список: GET /v1/users
data.paySystemId number ID платёжной системы. Список: GET /v1/pay-systems
data.sum number Сумма оплаты
data.currency string Код валюты. Список: GET /v1/currencies
data.paySystemName string Название платёжной системы
meta.readbackUnavailable boolean Приходит только со значением true, когда отметка снята, а перечитать оплату не удалось. Тогда data содержит только id. Повторять запрос не нужно — получите оплату по этому id

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

JSON 
{
  "success": true,
  "data": {
    "id": 565,
    "accountNumber": "1029/2",
    "paid": "N",
    "datePaid": "2026-10-05T09:29:34+03:00",
    "empPaidId": 1317,
    "paySystemId": 3,
    "sum": 0,
    "currency": "RUB",
    "paySystemName": "Банковский перевод (Контакты)"
  }
}

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

404 — оплаты с таким ID нет:

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

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Оплаты с таким id нет
400 READONLY_FIELD Тело запроса непустое
400 FST_ERR_CTP_EMPTY_JSON_BODY Передан заголовок Content-Type: application/json, а тело пустое. Передайте тело {} либо уберите заголовок
400 INVALID_ID id не положительное целое число
422 BITRIX_NO_EFFECT Битрикс24 не подтвердил снятие отметки
422 BITRIX_ERROR Битрикс24 отклонил запрос, причина — в error.message
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 — Ошибки.

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

Повторное снятие отметки не меняет оплату. Вызов для оплаты без отметки отвечает 200 с той же оплатой.

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