[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fpayments\u002Faggregate":3,"docs-tabs-entities\u002Fpayments\u002Faggregate":6},{"content":4,"lastmod":5},"\n## Агрегация оплат\n\n`POST \u002Fv1\u002Fpayments\u002Faggregate`\n\nПодсчёт количества оплат и числовые агрегации (`sum`, `avg`, `min`, `max`) по полю `sum`. Поддерживает фильтрацию и группировку по `paySystemId`, `orderId`, `currency`, `paid`, `responsibleId`.\n\n## Стандартные поля\n\n| Поле | Назначение |\n|------|------------|\n| `sum` | Единственное числовое поле — подходит для `sum` \u002F `avg` \u002F `min` \u002F `max` (название поля и функции совпадают, но это разные сущности) |\n| `paySystemId`, `orderId`, `responsibleId` | Идентификаторы — используются в `groupBy` (по платёжной системе, заказу, ответственному) |\n| `currency` | Категориальное — используется в `groupBy` (по валюте) |\n| `paid` | Логическое — используется в `groupBy` (оплачено \u002F не оплачено) |\n\nПолный список агрегируемых полей перечислен в таблице выше.\n\n## Поля запроса (тело)\n\n| Параметр | Тип | Обяз. | Описание |\n|----------|-----|:-----:|---------|\n| `aggregate` | array | нет | Массив агрегаций: `[{ \"field\": \"sum\", \"function\": \"sum\" }]`. Функции: `count`, `sum`, `avg`, `min`, `max`. Для `count` поле — `\"*\"`. Без параметра — только `count` (один запрос в Битрикс24, записи не выгружаются) |\n| `filter` | object | нет | Фильтрация — те же поля, что в [`GET \u002Fv1\u002Fpayments`](.\u002Flist.md). [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering) |\n| `groupBy` | string \\| string[] | нет | Поле или массив полей для группировки (максимум 5) |\n| `groupOrderBy` | array | нет | Сортировка групп: `[{ \"field\": \"sum:sum\", \"direction\": \"desc\" }]` |\n| `groupLimit` | number | нет | Ограничение количества возвращаемых групп (1-1000) |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fpayments\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [{ \"field\": \"sum\", \"function\": \"sum\" }],\n    \"groupBy\": \"paySystemId\"\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fpayments\u002Faggregate\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"aggregate\": [{ \"field\": \"sum\", \"function\": \"sum\" }],\n    \"groupBy\": \"paySystemId\"\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fpayments\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [{ field: 'sum', function: 'sum' }],\n    groupBy: 'paySystemId',\n  }),\n})\n\nconst { success, data } = await res.json()\nconsole.log(data.groups)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fpayments\u002Faggregate', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    aggregate: [{ field: 'sum', function: 'sum' }],\n    groupBy: 'paySystemId',\n  }),\n})\n\nconst { success, data } = await res.json()\n```\n\n## Другие сценарии\n\nПодсчёт записей — `count` с полем `\"*\"`, самый быстрый запрос без выгрузки записей. Без массива `aggregate` результат тот же:\n\n```json\n{ \"aggregate\": [{ \"field\": \"*\", \"function\": \"count\" }] }\n```\n\nСумма всех принятых оплат:\n\n```json\n{\n  \"aggregate\": [{ \"field\": \"sum\", \"function\": \"sum\" }],\n  \"filter\": { \"paid\": true }\n}\n```\n\nТоп-3 платёжных систем по сумме с сортировкой:\n\n```json\n{\n  \"aggregate\": [{ \"field\": \"sum\", \"function\": \"sum\" }],\n  \"groupBy\": \"paySystemId\",\n  \"groupOrderBy\": [{ \"field\": \"sum:sum\", \"direction\": \"desc\" }],\n  \"groupLimit\": 3\n}\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data.count` | number | Общее количество оплат, соответствующих фильтру |\n| `data.aggregates` | object | Результаты агрегаций: `{ \"sum\": { \"sum\": ..., \"avg\": ... } }` |\n| `data.groups` | array | Группы (только при `groupBy`) |\n| `data.meta.totalRecords` | number | Общее количество записей |\n| `data.meta.recordsProcessed` | number | Количество обработанных записей (до 5000) |\n| `data.meta.truncated` | boolean | `true`, если записей больше 5000 |\n| `data.meta.groupTotal` | number | Количество групп до `groupLimit` |\n| `data.meta.groupsTruncated` | boolean | Был ли список групп обрезан `groupLimit` |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"count\": 99,\n    \"aggregates\": {\n      \"sum\": { \"sum\": 8475.87 }\n    },\n    \"groups\": [\n      {\n        \"paySystemId\": 11,\n        \"count\": 87,\n        \"aggregates\": { \"sum\": { \"sum\": 5870.5 } }\n      },\n      {\n        \"paySystemId\": 6,\n        \"count\": 8,\n        \"aggregates\": { \"sum\": { \"sum\": 2025.37 } }\n      },\n      {\n        \"paySystemId\": 25,\n        \"count\": 4,\n        \"aggregates\": { \"sum\": { \"sum\": 580 } }\n      }\n    ],\n    \"meta\": {\n      \"totalRecords\": 99,\n      \"recordsProcessed\": 99,\n      \"truncated\": false,\n      \"groupTotal\": 3,\n      \"groupsTruncated\": false\n    }\n  }\n}\n```\n\nБез `groupBy` поле `data.groups` в ответе отсутствует.\n\n## Пример ответа при ошибке\n\n400 — поле в `groupBy` вне списка агрегируемых:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"groupBy field 'foo' is not aggregatable on this entity. Available: sum, currency, paid, paySystemId, orderId, responsibleId.\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `INVALID_PARAMS` | Неизвестная функция агрегации |\n| 400 | `INVALID_PARAMS` | Несуществующее числовое поле в `aggregate[].field` — сообщение `Field 'foo' not found. Available numeric fields: …` |\n| 400 | `INVALID_PARAMS` | Поле в `groupBy` вне списка агрегируемых — сообщение `groupBy field 'foo' is not aggregatable on this entity. Available: …` |\n| 400 | `INVALID_PARAMS` | Передано больше 5 полей в `groupBy` |\n| 400 | `INVALID_PARAMS` | Зарезервированные ключевые слова в `groupBy`: `count`, `aggregates`, `meta`, `groups` |\n| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sale` |\n| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**`count` против числовых функций.** `count` считается одним запросом в Битрикс24 — записи не выгружаются, ответ возвращается быстро на любом объёме. `sum` \u002F `avg` \u002F `min` \u002F `max` подгружают записи постранично (максимум 5000) и считают на стороне Вайбкод. При более чем 5000 записях `meta.truncated` будет `true`.\n\n**Группировка по `currency` важна на мультивалютных порталах.** Сумма всех оплат в `data.aggregates.sum.sum` без `groupBy: \"currency\"` смешивает разные валюты — реальный смысл получается только при разделении.\n\n## Смотрите также\n\n- [Поля оплаты](.\u002Ffields.md)\n- [Список оплат](.\u002Flist.md)\n- [Поиск оплат](.\u002Fsearch.md)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Лимиты и оптимизация](\u002Fdocs\u002Foptimization)\n","2026-07-02",{}]