Акты реализации

Отчёт поставщику о проданном за период товаре на реализации — основание его фактуры: разделы, строки и итоги.

Загружаем поисковый индекс…

Акты реализации

Объекты

ConsignmentSettlement

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • numberstringобязательно

    Номер акта.

  • statusstringобязательно

    draft — период собран для сверки, продажи ещё не закреплены за актом, период можно менять; posted — согласован с поставщиком: продажи периода закреплены за актом, по нему выставляется счёт; void — аннулирован: его продажи освобождены и войдут в следующий акт.

    Значения:
    draftpostedvoid
  • supplier_idintegerобязательно

    ID поставщика (/v1/suppliers).

  • legal_entity_idinteger или nullобязательно

    Юрлицо магазина, которому поставщик выставляет фактуру (/v1/legal-entities); null у старых актов — юрлицо по умолчанию.

  • supplier_bill_idinteger или nullобязательно

    Счёт по акту (/v1/supplier-bills); null — счёт ещё не выставлен или аннулирован, и акт можно выставить заново. Аннулированный счёт хранит связь в своём consignment_settlement_id.

  • currencystringобязательно

    Валюта акта, ISO 4217, — валюта цен поставки: в ней цены и суммы строк и итог.

  • period_fromstringобязательно

    Первый день периода, YYYY-MM-DD.

  • period_tostringобязательно

    Последний день периода, YYYY-MM-DD.

  • subtotalintegerобязательно

    Итог акта в его валюте — сумма строк, то, что поставщик выставит в фактуре.

  • base_subtotalintegerобязательно

    Тот же итог в валюте магазина.

  • sectionsмассив objectобязательно

    Подытоги по разделам в порядке документа; пустые разделы не выводятся.

    Поля · 2
    • kindstringобязательно

      sale — продано; loss — просрочка и недостача, которые по политике поставщика оплачивает магазин; price_adjustment — доплата за цену, исправленную корректировкой приёмки после начисления.

      Значения:
      salelossprice_adjustment
    • subtotalintegerобязательно

      Подытог раздела в валюте акта.

  • linesмассив objectобязательно

    Строки акта в порядке документа: вариант × приёмка × цена.

    Поля · 14
    • idintegerобязательно

      ID записи, уникальный среди записей своего вида в магазине.

    • positionintegerобязательно

      Номер строки в документе.

    • kindstringобязательно

      Раздел строки — коды sections[].kind.

      Значения:
      salelossprice_adjustment
    • variant_idinteger или nullобязательно

      ID варианта товара (/v1/variants).

    • lot_idinteger или nullобязательно

      ID партии строки (/v1/lots); null — товар без партий.

    • goods_receipt_idinteger или nullобязательно

      Приёмка, с которой пришёл товар (/v1/goods-receipts).

    • namestringобязательно

      Название позиции, как в документе: снято при сборке акта и не меняется при переименовании товара.

    • skustring или nullобязательно

      Артикул варианта, снятый вместе с названием; null, если его нет.

    • unitstring или nullобязательно

      Базовая единица количества строки: pcs — штуки, g — граммы, ml — миллилитры.

    • quantitystring или nullобязательно

      Сколько продано, списано или переоценено — десятичная строка в базовой единице; продажа, отменённая в том же периоде, вычтена.

    • unit_costinteger или nullобязательно

      Цена поставки в валюте акта за cost_per_quantity; у строки price_adjustment — новая цена. null — у приёмки нет цены, строка начислена по нулю.

    • cost_per_quantitystring или nullобязательно

      Количество в базовой единице, за которое указана цена: "1000" у весового товара — за килограмм.

    • amountintegerобязательно

      Сумма строки в валюте акта; у строки price_adjustment — разница к уже начисленному. Строки складываются в subtotal.

    • base_amountintegerобязательно

      Сумма строки в валюте магазина.

  • notestring или nullобязательно

    Заметка сотрудника; null, если её нет.

  • posted_atstring (date-time) или nullобязательно

    Когда акт проведён; null у черновика.

  • voided_atstring (date-time) или nullобязательно

    Когда акт аннулирован; null у действующего.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

Методы

Акты реализации: проданный, списанный за счёт магазина и переоценённый товар на реализации за период

get/consignment-settlements

Scope: procurement:read

Параметры

Строка запроса

  • limitinteger

    Размер страницы: до 250 записей; по умолчанию 50.

    Минимум:
    1
    Максимум:
    250
  • cursorstring

    Непрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.

    Макс. длина:
    4096
  • updated_sincestring (date-time)

    Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.

    Шаблон:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • supplier_idinteger

    Только документы этого поставщика.

    Минимум:
    1

Ответы

200Успешно

application/json

  • dataмассив ConsignmentSettlementобязательно

    Записи страницы.

  • deletedмассив objectобязательно

    Записи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.

    Поля · 2
    • idintegerобязательно

      ID стёртой записи.

    • deleted_atstring (date-time)обязательно

      Когда запись стёрта.

  • next_cursorstring или nullобязательно

    Курсор следующей страницы; null на последней.

  • has_morebooleanобязательно

    true, если есть следующая страница.

  • sync_cursorstring или nullобязательно

    На последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/consignment-settlements" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "number": "string",
      "status": "draft",
      "supplier_id": 0,
      "legal_entity_id": 0,
      "supplier_bill_id": 0,
      "currency": "string",
      "period_from": "string",
      "period_to": "string",
      "subtotal": 0,
      "base_subtotal": 0,
      "sections": [
        {
          "kind": "sale",
          "subtotal": 0
        }
      ],
      "lines": [
        {
          "id": 0,
          "position": 0,
          "kind": "sale",
          "variant_id": 0,
          "lot_id": 0,
          "goods_receipt_id": 0,
          "name": "string",
          "sku": "string",
          "unit": "string",
          "quantity": "string",
          "unit_cost": 0,
          "cost_per_quantity": "string",
          "amount": 0,
          "base_amount": 0
        }
      ],
      "note": "string",
      "posted_at": "2026-01-15T12:00:00Z",
      "voided_at": "2026-01-15T12:00:00Z",
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Акт реализации

get/consignment-settlements/{consignment_settlement}

Scope: procurement:read

Параметры

Путь

  • consignment_settlementintegerобязательно

    ID акта реализации.

Ответы

200Успешно

application/json

Возвращает ConsignmentSettlement

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/consignment-settlements/{consignment_settlement}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "number": "string",
  "status": "draft",
  "supplier_id": 0,
  "legal_entity_id": 0,
  "supplier_bill_id": 0,
  "currency": "string",
  "period_from": "string",
  "period_to": "string",
  "subtotal": 0,
  "base_subtotal": 0,
  "sections": [
    {
      "kind": "sale",
      "subtotal": 0
    }
  ],
  "lines": [
    {
      "id": 0,
      "position": 0,
      "kind": "sale",
      "variant_id": 0,
      "lot_id": 0,
      "goods_receipt_id": 0,
      "name": "string",
      "sku": "string",
      "unit": "string",
      "quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "amount": 0,
      "base_amount": 0
    }
  ],
  "note": "string",
  "posted_at": "2026-01-15T12:00:00Z",
  "voided_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}