Для AI-агентов: markdown этой страницы — /docs-content/entities/invoices/list.md индекс документации — /llms.txt

Список счетов

GET /v1/invoices

Возвращает список счетов с фильтрацией, сортировкой и пагинацией.

Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей за вызов, максимум 5000
offset number 0 Пропустить N записей — построчно: offset=7 начинает выборку с восьмой записи. При offset >= 2500 надёжнее limit <= 500
order object — Сортировка: ?order[createdTime]=desc. Краткая форма — ?sort=-createdTime, минус означает убывание. Допустимые имена перечисляет текст ошибки 400 UNKNOWN_SORT_FIELD — сортируется не всякое поле из GET /v1/invoices/fields
select string — Выборка полей: ?select=id,title,stageId. Принимает любое поле из GET /v1/invoices/fields
filter object — Фильтрация. Допустимые имена перечисляет текст ошибки 400 UNKNOWN_FILTER_FIELD — фильтруется не всякое поле из GET /v1/invoices/fields.
Синтаксис фильтрации. Пример: ?filter[stageId]=DT31_5:N

При limit > 50 выборка пагинируется на стороне сервера. Максимум за один вызов — 5000 записей. Есть ли записи за пределами отданной страницы, показывает meta.hasMore, а сколько их всего под фильтр — meta.total.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/invoices?limit=10&order[createdTime]=desc&filter[stageId]=DT31_5:N" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/invoices?limit=10&order[createdTime]=desc&filter[stageId]=DT31_5:N" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const params = new URLSearchParams({
  limit: '10',
  'order[createdTime]': 'desc',
  'filter[stageId]': 'DT31_5:N',
})

const res = await fetch(`https://vibecode.bitrix24.tech/v1/invoices?${params}`, {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data, meta } = await res.json()
console.log(`Найдено: ${meta.total}`)

JavaScript — OAuth-приложение

javascript 
const params = new URLSearchParams({
  limit: '10',
  'order[createdTime]': 'desc',
  'filter[stageId]': 'DT31_5:N',
})

const res = await fetch(`https://vibecode.bitrix24.tech/v1/invoices?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив счетов. Все поля элемента — см. Поля счёта
meta.total number Общее количество записей под фильтр
meta.hasMore boolean Есть ли ещё записи за пределами limit

URL карточки любого счёта из массива data — его id:

https://<portal>.bitrix24.ru/crm/type/31/details/<id>/

31 — entityTypeId смарт-счёта в Битрикс24. <portal> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

Пример ответа

Показаны основные поля. Полный состав записи — Поля счёта.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 117,
      "title": "Счёт за услуги",
      "stageId": "DT31_5:N",
      "categoryId": 5,
      "contactId": 485,
      "companyId": 0,
      "opportunity": 150000,
      "currencyId": "RUB",
      "assignedById": 1,
      "createdBy": 1,
      "createdTime": "2026-08-25T08:13:37.000Z",
      "updatedTime": "2026-08-25T08:13:37.000Z"
    },
    {
      "id": 113,
      "title": "Монтаж оборудования",
      "stageId": "DT31_5:N",
      "categoryId": 5,
      "contactId": 42,
      "companyId": 15,
      "opportunity": 42000,
      "currencyId": "RUB",
      "assignedById": 1,
      "createdBy": 1,
      "createdTime": "2026-08-19T11:02:14.000Z",
      "updatedTime": "2026-08-20T09:41:05.000Z"
    }
  ],
  "meta": {
    "total": 47,
    "hasMore": true
  }
}

Пример ответа при ошибке

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nosuchfield' for entity 'invoices'. Available: id, title, stageId, categoryId, assignedById, contactId, companyId, opportunity, currencyId, begindate, closedate, accountNumber, comments, mycompanyId, sourceId, sourceDescription, xmlId, opened, isManualOpportunity, isRecurring, createdBy, createdTime, updatedTime, updatedBy, movedBy, movedTime, previousStageId, lastCommunicationTime, lastCommunicationCallTime, lastCommunicationEmailTime, lastCommunicationImolTime, lastCommunicationWebformTime"
  }
}

Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого у счёта нет. В тексте ошибки перечислены допустимые имена
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого у счёта нет — в order или в краткой форме sort. В тексте ошибки перечислены допустимые имена
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

Пользовательские поля приходят без запроса. Без select каждая запись несёт и поля ufCrm_*, настроенные на портале, — на портале с сотнями таких полей ответ вырастает во много раз. Перечислите нужные имена в select, и в ответе останутся только они.

Смотрите также