#Поля счёта

GET /v1/invoices/fields

Возвращает описание всех полей счёта, включая пользовательские (ufCrm_*).

#Примеры

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

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

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

Terminal 
curl -X GET https://vibecode.bitrix24.tech/v1/invoices/fields \
  -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/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Полей:', Object.keys(data).length)

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

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

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

#Поля ответа

Поле Тип Только чтение Описание
id number да ID счёта
title string Название
stageId string Стадия. Формат: DT31_{categoryId}:{stage}. Список стадий: GET /v1/statuses?filter[entityId]=SMART_INVOICE_STAGE_{categoryId} — categoryId зависит от портала. Узнать: GET /v1/invoices?limit=1&select=categoryId или запросить у администратора
categoryId number ID воронки
contactId number ID контакта-плательщика. Поиск: GET /v1/contacts
companyId number ID компании-плательщика. Поиск: GET /v1/companies
mycompanyId number ID своей компании
opportunity number Сумма
currencyId string Валюта. Список: GET /v1/currencies
assignedById number Ответственный. Список: GET /v1/users
createdBy number да ID создателя
createdTime datetime да Дата создания
updatedTime datetime да Дата изменения

Пользовательские поля (ufCrm_*) возвращаются в ответе и доступны для записи.

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

JSON 
{
  "success": true,
  "data": {
    "id": {
      "type": "integer",
      "isRequired": false,
      "isReadOnly": true,
      "title": "ID"
    },
    "title": {
      "type": "string",
      "isRequired": false,
      "isReadOnly": false,
      "title": "Название"
    },
    "opportunity": {
      "type": "double",
      "isRequired": false,
      "isReadOnly": false,
      "title": "Сумма"
    }
  }
}

#Доступные include

Эндпоинт GET /v1/invoices/fields возвращает список доступных include: contact, company.

Пример использования: Получить invoices.

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

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

404 — не найден:

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

#Ошибки

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

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

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