Получить список оплат crm.item.payment.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: требуется право на чтение объекта CRM, из которого выбираются оплаты
Метод crm.item.payment.list возвращает все оплаты сделки или счета одним ответом, без постраничной навигации.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityId* |
Идентификатор сделки или счета. Получить идентификатор можно методом crm.item.list |
|
entityTypeId* |
Идентификатор типа объекта CRM. Оплаты есть только у двух типов:
Для других типов метод возвращает пустой массив |
|
filter |
Фильтр по полям оплаты в формате К ключу можно добавить префикс оператора:
Например, |
|
order |
Сортировка в формате
По умолчанию |
Метод не поддерживает параметр start: все оплаты объекта возвращаются в одном ответе.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":13123,"entityTypeId":2,"filter":{"@id":[1036,1037]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityId":13123,"entityTypeId":2,"filter":{"@id":[1036,1037]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.payment.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each payment item returned in result[]
type PaymentItem = {
id: number
accountNumber: string
paid: 'Y' | 'N'
datePaid: ISODate | null
empPaidId: number | null
paySystemId: number
sum: number
currency: string
paySystemName: string
}
try {
// crm.item.payment.list returns all records in one response, without pagination
const response = await $b24.actions.v2.call.make<PaymentItem[]>({
method: 'crm.item.payment.list',
params: {
entityId: 13123,
entityTypeId: 2,
filter: {
'@id': [1036, 1037],
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Payments:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function loadPaymentList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.item.payment.list returns all records in one response, without pagination
const response = await $b24.actions.v2.call.make({
method: 'crm.item.payment.list',
params: {
entityId: 13123,
entityTypeId: 2,
filter: {
'@id': [1036, 1037],
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Payments:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', loadPaymentList)
</script>
Пример
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.list(
entity_id=13123,
entity_type_id=2,
filter={
"@id": [
1036,
1037,
],
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.payment.list(
entity_id=13123,
entity_type_id=2,
filter={
"@id": [
1036,
1037,
],
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.item.payment.list',
[
'entityId' => 13123,
'entityTypeId' => 2,
'filter' => [
"@id" => [1036, 1037]
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching payment list: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.payment.list', {
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.item.payment.list',
[
'entityId' => 13123,
'entityTypeId' => 2,
'filter' => [
'@id' => [1036, 1037]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.item.payment.list", b24.Params{
"entityId": 13123,
"entityTypeId": 2,
"filter": b24.Params{
"@id": []int{1036, 1037},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.item.payment.list: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
AccountNumber string `json:"accountNumber"`
Paid string `json:"paid"`
DatePaid string `json:"datePaid"`
EmpPaidID b24.ID `json:"empPaidId"`
PaySystemID b24.ID `json:"paySystemId"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.AccountNumber)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"id": 1036,
"accountNumber": "1049/1",
"paid": "Y",
"datePaid": "2026-10-28T18:59:33+03:00",
"empPaidId": 1,
"paySystemId": 11,
"sum": 3000,
"currency": "RUB",
"paySystemName": "Наличные"
},
{
"id": 1037,
"accountNumber": "1049/2",
"paid": "N",
"datePaid": null,
"empPaidId": null,
"paySystemId": 19,
"sum": 3000,
"currency": "RUB",
"paySystemName": "ЮKassa"
}
],
"time": {
"start": 1793203179,
"finish": 1793203179.129769,
"duration": 0.12976908683776855,
"processing": 0,
"date_start": "2026-10-28T18:59:39+03:00",
"date_finish": "2026-10-28T18:59:39+03:00",
"operating_reset_at": 1793203740,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
Массив оплат объекта CRM (подробное описание). Если оплат нет, возвращается пустой массив |
|
|
time |
Информация о времени выполнения запроса |
sale_order_payment_crm_simple
|
Название |
Описание |
|
Идентификатор оплаты |
|
|
accountNumber |
Номер оплаты в формате |
|
paid |
Статус оплаты:
|
|
datePaid |
Дата и время, когда оплату последний раз отметили оплаченной. После crm.item.payment.unpay значение сохраняется |
|
empPaidId |
Идентификатор пользователя, который последним отметил оплату оплаченной. После crm.item.payment.unpay значение сохраняется |
|
paySystemId |
Идентификатор платежной системы |
|
sum |
Сумма оплаты. Пересчитывается автоматически, когда в оплату добавляют или из нее удаляют товары и доставку |
|
currency |
Валюта оплаты |
|
paySystemName |
Название платежной системы |
Обработка ошибок
HTTP-статус: 400
{
"error": "100",
"error_description": "Could not find value for parameter {entityId}"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Could not find value for parameter { |
Не передан обязательный параметр |
|
|
|
Internal server error. |
В |
|
|
|
Access denied |
Нет права на чтение объекта CRM |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Оплаты в универсальных объектах CRM: обзор методов
- Товарные позиции в оплате: обзор методов
- Доставки в оплатах: обзор методов
- Изменить поля оплаты crm.item.payment.update
- Удалить оплату crm.item.payment.delete
- Получить информацию об оплате crm.item.payment.get
- Изменить статус оплаты на «Оплачено» crm.item.payment.pay
- Изменить статус оплаты на «Не оплачено» crm.item.payment.unpay
- Добавить оплату crm.item.payment.add
- Как сохранить дату оплаты в поле сделки