Получить список оплат crm.item.payment.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: требуется право на чтение объекта CRM, из которого выбираются оплаты

Метод crm.item.payment.list возвращает все оплаты сделки или счета одним ответом, без постраничной навигации.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

entityId*
integer

Идентификатор сделки или счета. Получить идентификатор можно методом crm.item.list

entityTypeId*
integer

Идентификатор типа объекта CRM. Оплаты есть только у двух типов:

  • 2 — сделка
  • 31 — счет

Для других типов метод возвращает пустой массив

filter
object

Фильтр по полям оплаты в формате {"поле": "значение"}. Можно отбирать по полям из ответа метода: id, accountNumber, paid, datePaid, empPaidId, paySystemId, sum, currency, paySystemName.

К ключу можно добавить префикс оператора:

  • = — равно, используется по умолчанию
  • != — не равно
  • >, >=, <, <= — больше, больше или равно, меньше, меньше или равно
  • @ — входит в массив значений

Например, {"paid": "Y", ">sum": 1000} вернет оплаченные оплаты на сумму больше 1000. Если передать поле, которого нет в оплате, метод вернет ошибку Internal server error.

order
object

Сортировка в формате {"поле": "направление"}. Поля те же, что в filter. Направление:

  • ASC — по возрастанию
  • DESC — по убыванию

По умолчанию {"id": "ASC"}

Метод не поддерживает параметр 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
    }
}

Возвращаемые данные

Название
тип

Описание

result
sale_order_payment_crm_simple[]

Массив оплат объекта CRM (подробное описание). Если оплат нет, возвращается пустой массив

time
time

Информация о времени выполнения запроса

sale_order_payment_crm_simple

Название
тип

Описание

id
sale_order_payment.id

Идентификатор оплаты

accountNumber
string

Номер оплаты в формате номер заказа/порядковый номер оплаты, например 1045/1

paid
string

Статус оплаты:

  • Y — оплачена
  • N — не оплачена

datePaid
datetime

Дата и время, когда оплату последний раз отметили оплаченной. null, если оплату ни разу не проводили.

После crm.item.payment.unpay значение сохраняется

empPaidId
user.id

Идентификатор пользователя, который последним отметил оплату оплаченной. null, если оплату ни разу не проводили.

После crm.item.payment.unpay значение сохраняется

paySystemId
sale_paysystem.id

Идентификатор платежной системы

sum
double

Сумма оплаты. Пересчитывается автоматически, когда в оплату добавляют или из нее удаляют товары и доставку

currency
string

Валюта оплаты

paySystemName
string

Название платежной системы

Обработка ошибок

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Could not find value for parameter {entityId}"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Could not find value for parameter {имя параметра}

Не передан обязательный параметр entityId или entityTypeId

400

100

Internal server error.

В filter или order передано поле, которого нет в оплате

400

ACCESS_DENIED

Access denied

Нет права на чтение объекта CRM

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение