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

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

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

Scope: sale

Кто может выполнять метод: администратор

Метод получает список оплат.

Название
тип

Описание

select
array

Массив, содержащий список полей, которые необходимо выбрать.

Если не передан или передан пустой массив, то будут выбраны все доступные поля оплат.

Возможные значения элементов массива соответствуют полям объекта sale_order_payment

filter
object

Объект для фильтрации выбранных оплат в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта sale_order_payment.

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • = — равно (работает и с массивами)
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • > — больше
  • < — меньше
  • != — не равно
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
  • >= — больше либо равно
  • <= — меньше либо равно
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищем значения начинающиеся с «мол»
    • "%мол" — ищем значения заканчивающиеся на «мол»
    • "%мол%" — ищем значения, где «мол» может быть в любой позиции
  • %= — LIKE (смотрите описание выше)
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищем значения не начинающиеся с «мол»
    • "%мол" — ищем значения не заканчивающиеся на «мол»
    • "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (смотрите описание выше)

order
object

Объект для сортировки выбранных оплат в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта sale_order_payment.

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 50 записей.

Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Примеры кода

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
        
// 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 the payload returned in result (match the "response handling" section of the page)
        type SalePaymentListResult = {
          payments: {
            accountNumber: string
            comments: string
            companyId: number | null
            currency: string
            dateBill: ISODate | null
            dateMarked: ISODate | null
            datePaid: ISODate | null
            datePayBefore: ISODate | null
            dateResponsibleId: ISODate | null
            empMarkedId: number | null
            empPaidId: number | null
            empResponsibleId: number
            empReturnId: number | null
            externalPayment: string
            id: number
            id1c: string
            isReturn: string
            marked: string
            orderId: number
            paid: string
            payReturnComment: string
            payReturnDate: ISODate | null
            payReturnNum: string
            paySystemId: number
            paySystemIsCash: string
            paySystemName: string
            paySystemXmlId: string
            payVoucherDate: ISODate | null
            payVoucherNum: string
            priceCod: string
            psCurrency: string
            psInvoiceId: number | null
            psResponseDate: ISODate | null
            psStatus: string
            psStatusCode: string
            psStatusDescription: string
            psStatusMessage: string
            psSum: number | null
            reasonMarked: string
            responsibleId: number
            sum: number
            updated1c: string
            version1c: string
            xmlId: string
          }[]
        }
        
        try {
          // sale.payment.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<SalePaymentListResult>({
            method: 'sale.payment.list',
            params: {
              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',
              },
              start: 0,
            },
            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 on this page:', result.payments.length, result.payments)
          }
        } 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 fetchPaymentList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // sale.payment.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'sale.payment.list',
                params: {
                  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',
                  },
                  start: 0,
                },
                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 on this page:', result.payments.length, result.payments)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchPaymentList)
        </script>
        
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
object

Корневой элемент ответа

payments
sale_order_payment[]

Массив объектов с информацией о выбранных оплатах

total
integer

Общее количество найденных записей

time
time

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

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

HTTP-статус: 400

{
            "error":0,
            "error_description":"error"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

200040300010

Недостаточно прав для чтения оплат

0

Другие ошибки (например, фатальные ошибки)

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Получить оплату по Id
Следующая
Удалить оплату