Получить список оплат sale.payment.list
Scope:
saleКто может выполнять метод: администратор
Метод получает список оплат.
|
Название |
Описание |
|
select |
Массив, содержащий список полей, которые необходимо выбрать. Если не передан или передан пустой массив, то будут выбраны все доступные поля оплат. Возможные значения элементов массива соответствуют полям объекта sale_order_payment |
|
filter |
Объект для фильтрации выбранных оплат в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных оплат в формате Возможные значения для Возможные значения для order:
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["paySystemXmlId","paySystemIsCash","accountNumber","id","orderId","paid","datePaid","empPaidId","paySystemId","psStatus","psStatusCode","psStatusDescription","psStatusMessage","psSum","psCurrency","psResponseDate","payVoucherNum","payVoucherDate","datePayBefore","dateBill","xmlId","sum","currency","paySystemName","companyId","payReturnNum","priceCod","payReturnDate","empReturnId","payReturnComment","responsibleId","empResponsibleId","dateResponsibleId","isReturn","comments","updated1c","id1c","version1c","externalPayment","psInvoiceId","marked","reasonMarked","dateMarked","empMarkedId"],"filter":{"<id":10,"@personTypeId":[3,4],"payed":"N"},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.payment.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["paySystemXmlId","paySystemIsCash","accountNumber","id","orderId","paid","datePaid","empPaidId","paySystemId","psStatus","psStatusCode","psStatusDescription","psStatusMessage","psSum","psCurrency","psResponseDate","payVoucherNum","payVoucherDate","datePayBefore","dateBill","xmlId","sum","currency","paySystemName","companyId","payReturnNum","priceCod","payReturnDate","empReturnId","payReturnComment","responsibleId","empResponsibleId","dateResponsibleId","isReturn","comments","updated1c","id1c","version1c","externalPayment","psInvoiceId","marked","reasonMarked","dateMarked","empMarkedId"],"filter":{"<id":10,"@personTypeId":[3,4],"payed":"N"},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.payment.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'sale.payment.list',
{
"select": [
"paySystemXmlId",
"paySystemIsCash",
"accountNumber",
"id",
"orderId",
"paid",
"datePaid",
"empPaidId",
"paySystemId",
"psStatus",
"psStatusCode",
"psStatusDescription",
"psStatusMessage",
"psSum",
"psCurrency",
"psResponseDate",
"payVoucherNum",
"payVoucherDate",
"datePayBefore",
"dateBill",
"xmlId",
"sum",
"currency",
"paySystemName",
"companyId",
"payReturnNum",
"priceCod",
"payReturnDate",
"empReturnId",
"payReturnComment",
"responsibleId",
"empResponsibleId",
"dateResponsibleId",
"isReturn",
"comments",
"updated1c",
"id1c",
"version1c",
"externalPayment",
"psInvoiceId",
"marked",
"reasonMarked",
"dateMarked",
"empMarkedId",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
},
(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('sale.payment.list', {
"select": [
"paySystemXmlId",
"paySystemIsCash",
"accountNumber",
"id",
"orderId",
"paid",
"datePaid",
"empPaidId",
"paySystemId",
"psStatus",
"psStatusCode",
"psStatusDescription",
"psStatusMessage",
"psSum",
"psCurrency",
"psResponseDate",
"payVoucherNum",
"payVoucherDate",
"datePayBefore",
"dateBill",
"xmlId",
"sum",
"currency",
"paySystemName",
"companyId",
"payReturnNum",
"priceCod",
"payReturnDate",
"empReturnId",
"payReturnComment",
"responsibleId",
"empResponsibleId",
"dateResponsibleId",
"isReturn",
"comments",
"updated1c",
"id1c",
"version1c",
"externalPayment",
"psInvoiceId",
"marked",
"reasonMarked",
"dateMarked",
"empMarkedId",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
}, '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('sale.payment.list', {
"select": [
"paySystemXmlId",
"paySystemIsCash",
"accountNumber",
"id",
"orderId",
"paid",
"datePaid",
"empPaidId",
"paySystemId",
"psStatus",
"psStatusCode",
"psStatusDescription",
"psStatusMessage",
"psSum",
"psCurrency",
"psResponseDate",
"payVoucherNum",
"payVoucherDate",
"datePayBefore",
"dateBill",
"xmlId",
"sum",
"currency",
"paySystemName",
"companyId",
"payReturnNum",
"priceCod",
"payReturnDate",
"empReturnId",
"payReturnComment",
"responsibleId",
"empResponsibleId",
"dateResponsibleId",
"isReturn",
"comments",
"updated1c",
"id1c",
"version1c",
"externalPayment",
"psInvoiceId",
"marked",
"reasonMarked",
"dateMarked",
"empMarkedId",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
}, 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(
'sale.payment.list',
[
'select' => [
'paySystemXmlId',
'paySystemIsCash',
'accountNumber',
'id',
'orderId',
'paid',
'datePaid',
'empPaidId',
'paySystemId',
'psStatus',
'psStatusCode',
'psStatusDescription',
'psStatusMessage',
'psSum',
'psCurrency',
'psResponseDate',
'payVoucherNum',
'payVoucherDate',
'datePayBefore',
'dateBill',
'xmlId',
'sum',
'currency',
'paySystemName',
'companyId',
'payReturnNum',
'priceCod',
'payReturnDate',
'empReturnId',
'payReturnComment',
'responsibleId',
'empResponsibleId',
'dateResponsibleId',
'isReturn',
'comments',
'updated1c',
'id1c',
'version1c',
'externalPayment',
'psInvoiceId',
'marked',
'reasonMarked',
'dateMarked',
'empMarkedId',
],
'filter' => [
'<id' => 10,
'@personTypeId' => [3, 4],
'payed' => 'N',
],
'order' => [
'id' => 'desc',
],
]
);
$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(
"sale.payment.list",
{
"select": [
"paySystemXmlId",
"paySystemIsCash",
"accountNumber",
"id",
"orderId",
"paid",
"datePaid",
"empPaidId",
"paySystemId",
"psStatus",
"psStatusCode",
"psStatusDescription",
"psStatusMessage",
"psSum",
"psCurrency",
"psResponseDate",
"payVoucherNum",
"payVoucherDate",
"datePayBefore",
"dateBill",
"xmlId",
"sum",
"currency",
"paySystemName",
"companyId",
"payReturnNum",
"priceCod",
"payReturnDate",
"empReturnId",
"payReturnComment",
"responsibleId",
"empResponsibleId",
"dateResponsibleId",
"isReturn",
"comments",
"updated1c",
"id1c",
"version1c",
"externalPayment",
"psInvoiceId",
"marked",
"reasonMarked",
"dateMarked",
"empMarkedId",
],
"filter": {
"<id": 10,
"@personTypeId": [3, 4],
"payed": "N",
},
"order": {
"id": "desc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.payment.list',
[
'select' => [
"paySystemXmlId",
"paySystemIsCash",
"accountNumber",
"id",
"orderId",
"paid",
"datePaid",
"empPaidId",
"paySystemId",
"psStatus",
"psStatusCode",
"psStatusDescription",
"psStatusMessage",
"psSum",
"psCurrency",
"psResponseDate",
"payVoucherNum",
"payVoucherDate",
"datePayBefore",
"dateBill",
"xmlId",
"sum",
"currency",
"paySystemName",
"companyId",
"payReturnNum",
"priceCod",
"payReturnDate",
"empReturnId",
"payReturnComment",
"responsibleId",
"empResponsibleId",
"dateResponsibleId",
"isReturn",
"comments",
"updated1c",
"id1c",
"version1c",
"externalPayment",
"psInvoiceId",
"marked",
"reasonMarked",
"dateMarked",
"empMarkedId",
],
'filter' => [
"<id" => 10,
"@personTypeId" => [3, 4],
"payed" => "N",
],
'order' => [
"id" => "desc",
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"payments": [
{
"accountNumber": "163\/1",
"comments": "",
"companyId": null,
"currency": "RUB",
"dateBill": "2022-10-14T17:10:00+03:00",
"dateMarked": null,
"datePaid": null,
"datePayBefore": null,
"dateResponsibleId": "2022-10-14T17:10:00+03:00",
"empMarkedId": null,
"empPaidId": null,
"empResponsibleId": 1,
"empReturnId": null,
"externalPayment": "N",
"id": 9,
"id1c": "",
"isReturn": "N",
"marked": "N",
"orderId": 7,
"paid": "N",
"payReturnComment": "",
"payReturnDate": null,
"payReturnNum": "",
"paySystemId": 6,
"paySystemIsCash": "Y",
"paySystemName": "Наличные",
"paySystemXmlId": "bx_64134ba550ffa",
"payVoucherDate": null,
"payVoucherNum": "",
"priceCod": "0.000000",
"psCurrency": "",
"psInvoiceId": null,
"psResponseDate": null,
"psStatus": "",
"psStatusCode": "",
"psStatusDescription": "",
"psStatusMessage": "",
"psSum": null,
"reasonMarked": "",
"responsibleId": 1,
"sum": 1176,
"updated1c": "N",
"version1c": "",
"xmlId": "bx_634989d809dc8"
},
]
},
"total": 1,
"time": {
"start": 1713451909.778956,
"finish": 1713451910.23781,
"duration": 0.45885396003723145,
"processing": 0.09081101417541504,
"date_start": "2024-04-18T17:51:49+03:00",
"date_finish": "2024-04-18T17:51:50+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
payments |
Массив объектов с информацией о выбранных оплатах |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения оплат |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Оплаты в Интернет-магазине: обзор методов
- Добавить оплату sale.payment.add
- Изменить оплату sale.payment.update
- Получить оплату по Id sale.payment.get
- Удалить оплату sale.payment.delete
- Получить поля оплаты sale.payment.getFields