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

Получить оплату CRM

GET /v1/crm-payments/:id

Возвращает одну оплату CRM по ID, например чтобы проверить сумму после добавления позиций или узнать, отмечена ли оплата.

Параметры

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

Примеры

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

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-payments/563', {
  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 Номер оплаты: номер связанного заказа и порядковый номер оплаты через /, например 1029/1
data.paid string Отметка оплаты: Y — оплачена, N — нет
data.datePaid string | null Время последней отметки «оплачена», ISO 8601 со смещением часового пояса. null, если отметки не было
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 Название платёжной системы

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

JSON 
{
  "success": true,
  "data": {
    "id": 563,
    "accountNumber": "1029/1",
    "paid": "N",
    "datePaid": null,
    "empPaidId": null,
    "paySystemId": 19,
    "sum": 0,
    "currency": "RUB",
    "paySystemName": "ЮKassa"
  }
}

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

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

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

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Оплаты с таким id нет
400 INVALID_ID id не положительное целое число
422 BITRIX_ERROR Битрикс24 отклонил запрос, причина — в error.message
403 BITRIX_ACCESS_DENIED У пользователя ключа нет доступа к объекту CRM или оплате в Битрикс24
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
401 MISSING_API_KEY Не передан X-Api-Key

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

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

Снятие отметки не очищает время и автора последней отметки. После снятия отметки поля datePaid и empPaidId сохраняют значения последней отметки. Признак текущего состояния — только paid.

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