For AI agents: markdown of this page — /docs-content-en/entities/payments/aggregate.md documentation index — /llms.txt

Aggregate payments

POST /v1/payments/aggregate

Counts payments and computes numeric aggregations (sum, avg, min, max) over the sum field. Supports filtering and grouping by paySystemId, orderId, currency, paid, responsibleId.

Standard fields

Field Purpose
Fieldsum PurposeThe payment amount — the main field for sum / avg / min / max (the field and the function share a name, but they are different things). Numeric functions accept any field of type number from GET /v1/payments/fields
FieldpaySystemId, orderId, responsibleId PurposeIdentifiers — used in groupBy (by payment system, order, responsible employee)
Fieldcurrency PurposeCategorical — used in groupBy (by currency)
Fieldpaid PurposeBoolean — used in groupBy (paid / unpaid)

The full list of aggregatable fields is given in the table above.

Request fields (body)

Parameter Type Required Description
Parameteraggregate Typearray Requiredno DescriptionArray of aggregations: [{ "field": "sum", "function": "sum" }]. Functions: count, sum, avg, min, max. For count, the field is "*". Without the parameter — only count (a single request to Bitrix24, records are not fetched)
Parameterfilter Typeobject Requiredno DescriptionFiltering — the same fields as in GET /v1/payments. Filtering syntax
ParametergroupBy Typestring | string[] Requiredno DescriptionA field or an array of fields to group by (maximum 5)
ParametergroupOrderBy Typearray Requiredno DescriptionGroup sorting: [{ "field": "sum:sum", "direction": "desc" }]
ParametergroupLimit Typenumber Requiredno DescriptionLimit on the number of groups returned (1-1000)

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/payments/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [{ "field": "sum", "function": "sum" }],
    "groupBy": "paySystemId"
  }'

curl — OAuth application

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/payments/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregate": [{ "field": "sum", "function": "sum" }],
    "groupBy": "paySystemId"
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/payments/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [{ field: 'sum', function: 'sum' }],
    groupBy: 'paySystemId',
  }),
})

const { success, data } = await res.json()
console.log(data.groups)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/payments/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    aggregate: [{ field: 'sum', function: 'sum' }],
    groupBy: 'paySystemId',
  }),
})

const { success, data } = await res.json()

Other scenarios

Count records — count with field "*", the fastest request without fetching records. Without the aggregate array the result is the same:

JSON 
{ "aggregate": [{ "field": "*", "function": "count" }] }

Sum of all received payments:

JSON 
{
  "aggregate": [{ "field": "sum", "function": "sum" }],
  "filter": { "paid": true }
}

Top 3 payment systems by amount, sorted:

JSON 
{
  "aggregate": [{ "field": "sum", "function": "sum" }],
  "groupBy": "paySystemId",
  "groupOrderBy": [{ "field": "sum:sum", "direction": "desc" }],
  "groupLimit": 3
}

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.count Typenumber DescriptionTotal number of payments matching the filter
Fielddata.aggregates Typeobject DescriptionAggregation results: { "sum": { "sum": ..., "avg": ... } }
Fielddata.groups Typearray DescriptionGroups (only when groupBy is set)
Fielddata.meta.totalRecords Typenumber DescriptionTotal number of records
Fielddata.meta.recordsProcessed Typenumber DescriptionNumber of records processed (up to 5000)
Fielddata.meta.truncated Typeboolean Descriptiontrue when the numbers were computed over only some of the records that match the filter: fewer records were read than data.count promised — including when more than 5000 matched the filter — or the slice was cut short by a sub-page error. The size of the gap is reported in data.meta.recordsShortfall, the interrupted slice in data.meta.pageErrorSample. Always present, and false on a complete response. If the request has neither groupBy nor a numeric function, no records are fetched and the flag is always false
Fielddata.meta.groupTotal Typenumber DescriptionNumber of groups before groupLimit
Fielddata.meta.groupsTruncated Typeboolean DescriptionWhether the group list was truncated by groupLimit

Response example

JSON 
{
  "success": true,
  "data": {
    "count": 99,
    "aggregates": {
      "sum": { "sum": 8475.87 }
    },
    "groups": [
      {
        "paySystemId": 11,
        "count": 87,
        "aggregates": { "sum": { "sum": 5870.5 } }
      },
      {
        "paySystemId": 6,
        "count": 8,
        "aggregates": { "sum": { "sum": 2025.37 } }
      },
      {
        "paySystemId": 25,
        "count": 4,
        "aggregates": { "sum": { "sum": 580 } }
      }
    ],
    "meta": {
      "totalRecords": 99,
      "recordsProcessed": 99,
      "truncated": false,
      "groupTotal": 3,
      "groupsTruncated": false
    }
  }
}

Without groupBy, the data.groups field is absent from the response.

Error response example

400 — a groupBy field is outside the list of aggregatable fields:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'foo' is not aggregatable on this entity. Available: sum, currency, paid, paySystemId, orderId, responsibleId."
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionUnknown aggregation function
HTTP400 CodeINVALID_PARAMS DescriptionNon-existent numeric field in aggregate[].field — message Field 'foo' not found. Available numeric fields: …
HTTP400 CodeINVALID_PARAMS DescriptionA groupBy field outside the aggregatable list — message groupBy field 'foo' is not aggregatable on this entity. Available: …
HTTP400 CodeINVALID_PARAMS DescriptionMore than 5 fields passed in groupBy
HTTP400 CodeINVALID_PARAMS DescriptionReserved keywords in groupBy: count, aggregates, meta, groups
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the sale scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

For the full list of common API errors, see Errors.

Known specifics

count vs numeric functions. count is computed with a single request to Bitrix24 — records are not fetched and the response is fast at any volume. sum / avg / min / max fetch records page by page (maximum 5000) and compute on the Vibecode side. With more than 5000 records, meta.truncated will be true. The ceiling is not the only reason for this marker: it also appears when fewer records were read than data.count promised, and the size of the gap is reported in data.meta.recordsShortfall.

Grouping by currency matters on multi-currency Bitrix24 accounts. The total of all payments in data.aggregates.sum.sum without groupBy: "currency" mixes different currencies — it only becomes meaningful when split out.

The truncation marker travels with the number itself. When a response arrives with meta.truncated: true, the marker truncated: true sits inside every field object in data.aggregates and on every element of data.groups, and data.meta.warnings gains a warning with the code AGGREGATE_TRUNCATED. A client that reads only the number itself therefore sees that it was computed over only some of the records. None of these markers appear on a complete response. For full details, see Aggregation POST — the 5000-record ceiling.

See also