Получить список оплат crm.item.payment.list
Scope:
crmКто может выполнять метод: требуется право на чтение объекта CRM, из которого выбираются оплаты
Метод получает список оплат конкретного объекта CRM.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityId* |
Идентификатор объекта CRM |
|
entityTypeId* |
Идентификатор |
|
filter |
Дополнительный фильтр для случаев, когда нужно получить не все оплаты сущности, а по какому-то более специфичному фильтру. |
|
order |
Описание формата приведено в параметре order метода |
Примеры кода
Как использовать примеры в документации
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
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'crm.item.payment.list',
{
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
}
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('crm.item.payment.list', {
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
}
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('crm.item.payment.list', {
entityId: 13123,
entityTypeId: 2,
filter: {
"@id": [1036, 1037]
}
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', 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>';
Ответ в случае успеха
HTTP-статус: 200
{
"result":[
{
"id":1036,
"accountNumber":"3653\/1",
"paid": "Y",
"datePaid":"2024-05-20T12:32:02+03:00",
"empPaidId":1,
"paySystemId":6,
"sum":0,
"currency":"RUB",
"paySystemName":"Наличные"
},
{
"id":1037,
"accountNumber":"3653\/2",
"paid": "N",
"datePaid":null,
"empPaidId":null,
"paySystemId":6,
"sum":0,
"currency":"RUB",
"paySystemName":"Наличные"
}
],
"time":{
"start":1716205783.285524,
"finish":1716205783.702053,
"duration":0.41652917861938477,
"processing":0.15817594528198242,
"date_start":"2024-05-20T14:49:43+03:00",
"date_finish":"2024-05-20T14:49:43+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
Массив объектов, содержащий краткую информацию о выбранных оплатах |
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"Недостаточно прав"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Доступ запрещен |
|
|
Не переданы обязательные поля |
|
|
Другие ошибки (например, фатальные ошибки) |
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить поля оплаты crm.item.payment.update
- Удалить оплату crm.item.payment.delete
- Получить информацию об оплате crm.item.payment.get
- Изменить статус оплаты на «Оплачено» crm.item.payment.pay
- Изменить статус оплаты на «Не оплачено» crm.item.payment.unpay
- Добавить оплату crm.item.payment.add
- Как сохранить дату оплаты в поле сделки