Stock documents

Получить журнал складских документов

Журнал показывает только виды документов модуля stock и только юрлица, доступные пользователю.

get/api/v1/stock/documents

Request

  • Base URL: https://erp.akeda.ru
  • URL: https://erp.akeda.ru/api/v1/stock/documents
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key
    • OAuth 2 (authorization code, authorization URL https://erp.akeda.ru/oauth2/authorize, token URL https://erp.akeda.ru/oauth2/token, scopes: akeda:delegate)
    • HTTP bearer

Query parameters

type'stock_receipt' | 'stock_shipment' | 'stock_transfer' | 'stock_writeoff' | 'stock_capitalization' | 'stock_supplier_return' | 'stock_customer_return' | 'stock_purchase_request' | 'stock_supplier_order' | 'stock_inventory' | 'stock_reservation' | 'stock_landed_cost' | 'stock_receipt_cost' | 'stock_assembly' | 'stock_disassembly' | 'stock_reservation_release' | 'stock_supplier_order_close' | 'stock_opening_balance' | 'stock_marketplace_return' | 'stock_account_transfer' | 'stock_condition_change' | 'stock_regrade' | 'supplier_order'

Вид складского документа. Служебные виды заводит только модуль: stock_reservation_release — при снятии остатка резерва. Виды stock_opening_balance и stock_marketplace_return заводит ввод остатков и учёт склада площадки, stock_account_transfer — stockCreateAccountTransfer; общей ручкой они не создаются. Доп. расходы stock_receipt_cost заводит /stock/receipt-costs; прежние накладные расходы stock_landed_cost только читаются. Заказ поставщику — документ ядра supplier_order (этап 2 ERP-1427): склад отдаёт его своим видом, и отбор журнала принимает оба имени. Прежние виды stock_supplier_order и stock_supplier_order_close остались в истории движений; новых документов этих видов нет.

Ключ вида складского документа

status'draft' | 'posted' | 'cancelled'
date_fromstring date
date_tostring date
company_idstring uuid
warehouse_idstring uuid

Совпадает со складом, складом-отправителем или складом-получателем

warehouse_idsstring

Набор складов через запятую: отбор столбца «Склад». Сравнение точное — по складу, отправителю и получателю; зоны клиент передаёт сам

contact_idstring uuid
created_bystring

Авторы документов через запятую (id пользователей): отбор столбца «Автор». Значения — из /documents/authors

numberstring

Отбор столбца «Номер»: подстрока номера без учёта регистра

commentstring

Отбор столбца «Комментарий»: подстрока комментария без учёта регистра

updated_fromstring date

Отбор столбца «Изменён» с дня включительно, YYYY-MM-DD

updated_tostring date

Отбор столбца «Изменён» по день включительно, YYYY-MM-DD

lines_frominteger

Отбор столбца «Строк»: число строк табличной части от, включительно

lines_tointeger

Отбор столбца «Строк»: число строк табличной части до, включительно; 0 — документы без строк

qty_fromstring

Отбор столбца «Кол-во»: сумма количества строк от, включительно

qty_tostring

Отбор столбца «Кол-во»: сумма количества строк до, включительно

salestring

Отбор столбца «Продажа»: подстрока номера продажи, к которой отнесён документ

qstring

Номер или комментарий

sort'date' | 'number' | 'status' | 'company' | 'warehouse' | 'contact' | 'updated_at'
direction'asc' | 'desc'
limitinteger
reason_idstring uuid

Причина списания из справочника stock.stock_writeoff_reasons; берётся из payload документа

marks'short'

Отбор столбца «Марки»: short — документы, которым по сводке маркировки не хватает марок

marketplace_shipment'true'

true — только «Отгрузки на маркетплейс» (ERP-2137): перемещения со ссылкой marketplace_store

marketplace_store_idstring uuid

Отгрузки на маркетплейс этого магазина площадки

supplystring

Отбор столбца «Поставка площадки» (ERP-2423): подстрока номера поставки payload.marketplace_shipment.supply_number, у отправки на склад площадки без API — комментария

receiverstring

Отбор столбца «Контрагент» отгрузок на маркетплейс (ERP-2423): подстрока имени контрагента, склада-получателя или склада, для которого он «в пути»; вместе с receiver_stores

receiver_storesstring

Магазины площадки через запятую, чьё имя совпало с receiver на экране: магазины живут в модуле маркетплейсов

shelf_life_warningboolean

Отбор «с пометкой срока годности»: true — только проведённые документы, проведение которых взяло партию, не проходящую правило срока (просроченную или ниже порога), — документы обхода маркетплейсов. Отбор серверный, счётчик и страницы считаются по нему

offsetinteger
pnl_item_idstring uuid

Списания, снявшие эту статью ОПиУ с причины (payload.pnl_item_id, ERP-2423)

department_idstring uuid

Списания, отнесённые на это подразделение (entity_refs.department, ERP-2423)

transfer_kindstring

Вид перемещения через запятую (ERP-2179): transfer — перемещение, shipment — отправка на склад с приёмкой, receipt — приёмка по отправке, auto_receipt — приёмка при отгрузке, marketplace_acceptance — приёмка площадкой (со склада «в пути на площадку» на её склад, заводит обход), marketplace_shipment — отгрузка на маркетплейс по поставке через API площадки, marketplace_dispatch — отправка на склад площадки без API

warehouse_from_idsstring

Отбор столбца «Откуда» (ERP-2542): склады-отправители перемещения через запятую, точное сравнение (зоны узла вызывающий разворачивает сам); пусто — отбора нет. Вместе с warehouse_to_ids даёт входящие на склад, исходящие со склада и конкретную пару. Отбор серверный, счётчик и страницы считаются по нему

warehouse_to_idsstring

Отбор столбца «Куда» (ERP-2542): склады-получатели перемещения через запятую, точное сравнение; пусто — отбора нет

Headers

X-Tenantstring required

Slug выбранного кабинета; кабинет не является юрлицом

Response

Журнал складских документов

countinteger required
limitinteger required
offsetinteger required
shelf_life_warningsobject

Документы страницы с пометкой срока годности (ERP-1821): идентификатор документа → сколько партий помечено в его проведении (payload.posting.shelf_life_warnings). Только проведённые документы; документа без пометки в наборе нет, а без помеченных документов нет и самого поля

Changes

No recorded changes to this operation across all 1 revision of this API.