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

GET /v1/invoices/:id

Возвращает счёт по ID. Поддерживает включение связанных сущностей через include.

#Параметры запроса

Параметр Тип Описание
id number ID счёта (в URL)

#Примеры

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

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

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

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/invoices/891" \
  -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/891', {
  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/891', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Подробнее об include: Связанные данные.

#Поля ответа

Поле Тип Описание
id number ID счёта
title string Название
stageId string Стадия
categoryId number ID воронки
contactId number ID контакта
companyId number ID компании
opportunity number Сумма
currencyId string Валюта
assignedById number Ответственный
createdBy number Создатель
createdTime datetime Дата создания
updatedTime datetime Дата изменения
_included object Связанные сущности (при include)

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

(include)

GET /v1/invoices/1?include=contact,company

Доступные include: contact, company. Результат в поле _included.

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

JSON 
{
  "success": true,
  "data": {
    "id": 891,
    "title": "Счёт за услуги",
    "stageId": "DT31_5:N",
    "categoryId": 5,
    "contactId": 42,
    "companyId": 15,
    "opportunity": 150000,
    "currencyId": "RUB",
    "assignedById": 1,
    "createdBy": 1,
    "createdTime": "2026-04-15T14:30:00+03:00",
    "updatedTime": "2026-04-15T14:30:00+03:00",
    "_included": {
      "contact": {
        "id": 42,
        "name": "Иван",
        "lastName": "Петров"
      },
      "company": {
        "id": 15,
        "title": "ООО Ромашка"
      }
    }
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Entity not found"
  }
}

Подробнее об include: Связанные данные.

#Ошибки

HTTP Код Описание
404 NOT_FOUND Счёт с указанным ID не найден
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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