Skip to content

Latest commit

 

History

History
347 lines (305 loc) · 13.1 KB

sale-payment-list.md

File metadata and controls

347 lines (305 loc) · 13.1 KB
Raw

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

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 — номер нужной страницы || |#

Примеры кода

{% list tabs %}

  • cURL (Webhook)

    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_webbhook_here**/sale.payment.list

  • cURL (OAuth)

    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

  • JS

    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());
        }
    }
);

  • PHP

    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>';

{% endlist %}

Обработка ответа

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"
}

{% include notitle обработка ошибок %}

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

#| || Код | Описание || || 200040300010 | Недостаточно прав для чтения оплат || || 0 | Другие ошибки (например, фатальные ошибки) || |#

{% include системные ошибки %}

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