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

Получить счёт

GET /v1/invoices/:id

Возвращает счёт по ID со всеми полями, включая пользовательские.

Параметры

Параметр Тип Обяз. Описание
id (path) number да ID счёта
include (query) string нет Связанные записи: contact, company, deal. Что приходит в ответе — секция «Связанные данные»
select (query) string нет Выборка полей: ?select=id,title,stageId

Примеры

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/invoices/117" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/invoices/117" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { success, data } = await res.json()
console.log('Получено:', data.id)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Счёт целиком. Все поля — см. Поля счёта

Связанные данные

Параметр принимает три имени — contact, company и deal:

GET /v1/invoices/117?include=contact,company,deal

Имена проверяются: любое другое значение отклоняется с 400 INVALID_INCLUDE, и в тексте ошибки перечислены допустимые. При заполненных contactId, companyId и parentId2 в ответе появляется блок _included с объектами контакта, компании и сделки (или null, если соответствующая ссылка пустая).

Общее описание механизма — Связанные данные.

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

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

JSON 
{
  "success": true,
  "data": {
    "id": 117,
    "title": "Счёт за услуги",
    "stageId": "DT31_5:N",
    "categoryId": 5,
    "contactId": 485,
    "companyId": 73,
    "parentId2": 40,
    "opportunity": 150000,
    "currencyId": "RUB",
    "assignedById": 1,
    "createdBy": 1,
    "createdTime": "2026-08-25T08:13:37.000Z",
    "updatedTime": "2026-08-25T08:13:37.000Z",
    "_included": {
      "contact": { "id": 485 },
      "company": { "id": 73 },
      "deal": { "id": 40 }
    }
  }
}

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

404 — счёт не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Счёт с указанным ID не найден
400 INVALID_PARAMS id в адресе не целое неотрицательное число
400 INVALID_INCLUDE В include передано имя, которого у счёта нет. В тексте ошибки перечислены допустимые
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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