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

Установить товары счёта

PUT /v1/invoices/:id/products

Устанавливает товарные позиции счёта. Полностью заменяет текущий список — передайте все нужные позиции.

Имена полей проверяются. Поле, которого нет среди записываемых, не отбрасывается молча: запрос отклоняется с 400 INVALID_PARAMS, и в тексте ошибки перечислены записываемые имена. Поля только для чтения, которые приходят в ответах товарных позиций — priceAccount, ownerId, storeId и другие, — принимаются и игнорируются, поэтому объект, прочитанный через GET, можно отправить обратно без чистки.

Идентификаторы позиций не переносятся. Позиция, поля которой не изменились, сохраняет свой id. Изменённая приходит с новым id, даже если прежний идентификатор передан в теле. Чтобы отредактировать позицию и сохранить её id, используйте PATCH /v1/invoices/:id/products/:rowId.

Поля запроса (body)

Параметр Тип Обяз. Описание
items array да Массив товарных позиций
items[].productId number нет ID товара из каталога. Каталог: GET /v1/products. Без productId и productName позиция создаётся без товара и с пустым названием
items[].productName string нет Название позиции — для произвольной строки без товара из каталога
items[].price number нет Цена за единицу. Без него позиция создаётся с нулевой ценой
items[].quantity number нет Количество. Без него позиция создаётся с количеством 1
items[].discountTypeId number нет Как задана скидка: 1 — суммой в поле discount, 2 — процентом в поле discountRate. По умолчанию 2
items[].discount number нет Сумма скидки. Учитывается только при discountTypeId равном 1
items[].discountRate number нет Процент скидки. Учитывается только при discountTypeId равном 2
items[].taxRate number нет Ставка налога (%)
items[].taxIncluded boolean нет Налог включён в цену

Примеры

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

Terminal 
curl -X PUT "https://vibecode.bitrix24.tech/v1/invoices/58/products" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "productId": 1, "price": 25000, "quantity": 2 },
      { "productId": 5, "price": 5000, "quantity": 1, "discountTypeId": 1, "discount": 500 }
    ]
  }'

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

Terminal 
curl -X PUT "https://vibecode.bitrix24.tech/v1/invoices/58/products" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "productId": 1, "price": 25000, "quantity": 2 },
      { "productId": 5, "price": 5000, "quantity": 1, "discountTypeId": 1, "discount": 500 }
    ]
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/invoices/58/products', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { productId: 1, price: 25000, quantity: 2 },
      { productId: 5, price: 5000, quantity: 1, discountTypeId: 1, discount: 500 },
    ],
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/invoices/58/products', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    items: [
      { productId: 1, price: 25000, quantity: 2 },
      { productId: 5, price: 5000, quantity: 1, discountTypeId: 1, discount: 500 },
    ],
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив установленных позиций
data[].productId number ID товара из каталога
data[].productName string Название позиции
data[].price number Цена за единицу
data[].quantity number Количество
data[].discount number Сумма скидки
data[].discountTypeId number Как задана скидка: 1 — суммой, 2 — процентом
data[].taxRate number | null Ставка налога (%)
data[].taxIncluded boolean Налог включён в цену

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

JSON 
{
  "success": true,
  "data": [
    {
      "productId": 1,
      "productName": "Серверное оборудование",
      "price": 25000,
      "quantity": 2,
      "discount": 0,
      "discountTypeId": 2,
      "taxRate": null,
      "taxIncluded": false
    },
    {
      "productId": 5,
      "productName": "Установка и настройка",
      "price": 5000,
      "quantity": 1,
      "discount": 500,
      "discountTypeId": 1,
      "taxRate": null,
      "taxIncluded": false
    }
  ]
}

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

400 — неверный формат:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "items must be an array"
  }
}

Ошибки

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

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

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

Полная замена: PUT заменяет весь список товаров. Чтобы добавить позицию — сначала получите текущие (GET), добавьте новую в массив, отправьте всё (PUT). Забирайте список целиком: без limit GET отдаёт только первую страницу, поэтому передавайте limit=5000 либо листайте по offset, пока meta.hasMore не станет false. Неполный список, отправленный обратно, сотрёт остальные позиции. Пустой массив items стирает все позиции счёта.

Скидка суммой требует discountTypeId: 1. По умолчанию тип скидки равен 2, то есть процент, и в этом режиме поле discount не сохраняется: позиция приходит с discount: 0, ошибки при этом нет. Задавая скидку суммой, передавайте discountTypeId: 1 вместе с discount, а процентом — discountRate при типе 2.

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