Списания

7 статьи Максим От Максим

Методы для списаний материалов и продуктов

Списания

Списания: расход материалов и продуктов со склада вне заказов и производства, например брак, порча или материалы на собственные нужды. Через API списания можно создавать, редактировать и удалять, менять их статус, получать список и данные списания. Пути методов указаны относительно базового адреса API, а общие для всех методов правила (авторизация, формат запросов, частичное редактирование, постраничная выдача) описаны в статьях Обзор API и Общие правила. Методы | Метод | Что делает | |---|---| | v1/writeoffs/add | Создает списание | | v1/writeoffs/edit | Изменяет списание | | v1/writeoffs/delete | Удаляет списание | | v1/writeoffs/update_status | Меняет статус списания | | v1/writeoffs/get_list | Возвращает список списаний | | v1/writeoffs/get_entry | Возвращает списание со строками |

Создание списания

Создает списание материалов и продуктов со склада. v1/writeoffs/add.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | num | string | Да | Номер | | materials | array | materials или products | Списываемые материалы: id или sku и amount | | products | array | materials или products | Списываемые продукты: id или sku и amount | | date | string | Нет | Дата списания, YYYY-MM-DD. По умолчанию сегодня | | materials_storage_id | int | Нет | Склад, с которого списываются материалы. По умолчанию склад для списаний из настроек компании | | products_storage_id | int | Нет | Склад, с которого списываются продукты. По умолчанию склад для списаний из настроек компании | | notes | string | Нет | Заметки | Строка materials и products: | Поле | Тип | Обязательное | Описание | |---|---|---|---| | id | int | id или sku | ID материала или продукта | | sku | string | id или sku | Артикул | | amount | float | Да | Количество, больше 0 | | notes | string | Нет | Комментарий к строке | Материал или продукт указывается по id или sku. Нужна хотя бы одна строка в одном из массивов. Новое списание создается в статусе из настройки Статус нового списания по умолчанию. Пример запроса { "num": "48", "date": "2026-10-06", "materials": [ { "id": 2051, "amount": 0.15, "notes": "Брак: трещина" } ], "products": [ { "sku": "P-TABLE-01", "amount": 1 } ], "materials_storage_id": 3998, "products_storage_id": 4001, "notes": "Брак при распиле" } Пример ответа { "success": true, "writeoff_id": 19291, "num": "48", "status": 1 } В ответе приходят ID, номер и код статуса нового списания. Ошибки | Ошибка | Причина | |---|---| | No num in input | Не передан num или он пустой | | No products or materials in input | Не передано ни одной строки | | Materials is not an array | materials не массив (так же для products) | | Line 0 of materials must be an object | Строка не объект (вместо 0 будет номер строки) | | SKU or id not set for material 0 | В строке нет ни id, ни sku | | Material with id 2051 not found | Материал не найден или удален (для продукта: Product with SKU "P-TABLE-01" not found) | | Amount must be greater than 0 for material with id 2051 | Количество не число или не больше 0 после округления | | Invalid notes value for material with id 2051. Must be a string | notes в строке не строка | | Notes for material with id 2051 are too long: maximum 10000 characters | Комментарий строки длиннее 10 000 символов | | Storage ID not found | Склад не найден или удален | | Date is not a valid date in format YYYY-MM-DD | Неверный формат даты |

Редактирование списания

Изменяет списание. Меняются только переданные поля, остальные остаются прежними. Подробнее о частичном редактировании в статье Общие правила. v1/writeoffs/edit.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | writeoff_id | int | Да | ID списания | | materials | array | Нет | Списываемые материалы: id или sku и amount | | products | array | Нет | Списываемые продукты: id или sku и amount | | num | string | Нет | Номер | | date | string | Нет | Дата списания, YYYY-MM-DD | | materials_storage_id | int | Нет | Склад, с которого списываются материалы. 0: склад по умолчанию для списаний | | products_storage_id | int | Нет | Склад, с которого списываются продукты. 0: склад по умолчанию для списаний | | notes | string | Нет | Заметки | Если передан хотя бы один из массивов materials и products, строки заменяются целиком, а непереданный массив считается пустым. Если не передан ни один, строки остаются прежними. Статус этим методом не меняется, для него есть v1/writeoffs/update_status. Пример запроса { "writeoff_id": 19291, "materials": [ { "id": 2051, "amount": 0.2 } ] } В этом примере передан только materials, поэтому продукт из списания удаляется. Пример ответа { "success": true } Ошибки | Ошибка | Причина | |---|---| | No writeoff_id in input | Не передан writeoff_id | | Write-off not found or access denied | Списание не найдено или удалено | | No products or materials in input | Массивы строк переданы, но пустые | | Material with id 2051 not found | Материал не найден или удален | | Amount must be greater than 0 for material with id 2051 | Количество не число или не больше 0 после округления | | Storage ID not found | Склад не найден или удален | | Date is not a valid date in format YYYY-MM-DD | Неверный формат даты | Остальные ошибки строк такие же, как в v1/writeoffs/add.

Удаление списания

Удаляет списание. v1/writeoffs/delete.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | writeoff_id | int | Да | ID списания | Удаление нельзя отменить. Списанные материалы и продукты возвращаются на склад. Пример запроса { "writeoff_id": 19291 } Пример ответа { "success": true } Ошибки | Ошибка | Причина | |---|---| | No writeoff_id in input | Не передан writeoff_id | | Write-off not found or access denied | Списание не найдено или уже удалено |

Смена статуса списания

Меняет статус списания. От статуса зависит, списаны ли материалы и продукты со склада. v1/writeoffs/update_status.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | writeoff_id | int | Да | ID списания | | status | int | Да | Новый статус: 0 — План, 1 — Списано | Пример запроса { "writeoff_id": 19291, "status": 1 } Пример ответа { "success": true } Ошибки | Ошибка | Причина | |---|---| | No writeoff_id in input | Не передано обязательное поле (вместо writeoff_id будет имя поля) | | Invalid status value. Must be one of: 0, 1 | Неверный код статуса | | Write-off not found or access denied | Списание не найдено или удалено |

Получение списка списаний

Возвращает списания компании, от новых к старым: по дате, а внутри одной даты по ID. Строки в список не входят, их возвращает v1/writeoffs/get_entry. v1/writeoffs/get_list.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | date_from | string | Нет | Списания с этой даты включительно, YYYY-MM-DD | | date_to | string | Нет | Списания по эту дату включительно, YYYY-MM-DD | | status | int | Нет | Статус: 0 План, 1 Списано | | limit | int | Нет | Размер страницы, от 1 до 1000 | | offset | int | Нет | Сколько записей пропустить | Без limit возвращается весь список. Подробнее о постраничной выдаче в статье Общие правила. Ответ Массив writeoffs с полями списания: | Поле | Тип | Описание | |---|---|---| | id | int | ID списания | | num | string | Номер | | date | string | Дата списания, YYYY-MM-DD | | status | int | Статус: 0 План, 1 Списано | | materials_storage_id | int | Склад, с которого списываются материалы | | materials_storage_name | string | Название склада материалов | | products_storage_id | int | Склад, с которого списываются продукты | | products_storage_name | string | Название склада продуктов | | cost | float | Себестоимость списанного | | amount | float | Общее количество. null, если у позиций разные единицы измерения | | lines | int | Количество строк | | notes | string | Заметки | Поле total содержит общее число списаний, подходящих под фильтры. Пример запроса { "date_from": "2026-10-01", "date_to": "2026-10-31", "limit": 100, "offset": 0 } Пример ответа { "success": true, "writeoffs": [ { "id": 19291, "num": "48", "date": "2026-10-06", "status": 1, "materials_storage_id": 3998, "materials_storage_name": "Главный", "products_storage_id": 4001, "products_storage_name": "Готовая продукция", "cost": 26350, "amount": null, "lines": 2, "notes": "Брак при распиле" } ], "total": 1 } Ошибки | Ошибка | Причина | |---|---| | Date is not a valid date in format YYYY-MM-DD | Неверный формат date_from или date_to | | Invalid status value. Must be a number | status не число | | Invalid limit value. Must be between 1 and 1000 | Неверный limit | | Offset requires limit | Передан offset без limit |

Получение данных списания

Возвращает списание с его строками. v1/writeoffs/get_entry.php Параметры | Поле | Тип | Обязательное | Описание | |---|---|---|---| | writeoff_id | int | Да | ID списания | Ответ Объект writeoff с полями списания: | Поле | Тип | Описание | |---|---|---| | id | int | ID списания | | num | string | Номер | | date | string | Дата списания, YYYY-MM-DD | | status | int | Статус: 0 План, 1 Списано | | materials_storage_id | int | Склад, с которого списываются материалы | | materials_storage_name | string | Название склада материалов | | products_storage_id | int | Склад, с которого списываются продукты | | products_storage_name | string | Название склада продуктов | | cost | float | Себестоимость списанного | | amount | float | Общее количество. null, если у позиций разные единицы измерения | | lines | int | Количество строк | | notes | string | Заметки | И строки в двух массивах: materials и products. Если позиций одного типа нет, массив пустой. | Поле | Тип | Описание | |---|---|---| | id | int | ID материала или продукта | | sku | string | Артикул | | name | string | Название | | amount | float | Количество | | unit | string | Единица измерения | | cost | float | Себестоимость строки | | position | int | Номер строки в списании, с 0. Нумерация общая для материалов и продуктов | | notes | string | Комментарий к строке. Пустая строка, если его нет | Строки из ответа можно отправить в v1/writeoffs/edit без изменений. Пример запроса { "writeoff_id": 19291 } Пример ответа { "success": true, "writeoff": { "id": 19291, "num": "48", "date": "2026-10-06", "status": 1, "materials_storage_id": 3998, "materials_storage_name": "Главный", "products_storage_id": 4001, "products_storage_name": "Готовая продукция", "cost": 26350, "amount": null, "lines": 2, "notes": "Брак при распиле", "materials": [ { "id": 2051, "sku": "M010", "name": "Доска дубовая", "amount": 0.15, "unit": "куб. м", "cost": 20250, "position": 0, "notes": "Брак: трещина" } ], "products": [ { "id": 512, "sku": "P-TABLE-01", "name": "Стол обеденный", "amount": 1, "unit": "шт", "cost": 6100, "position": 1, "notes": "" } ] } } Ошибки | Ошибка | Причина | |---|---| | No writeoff_id in input | Не передан writeoff_id | | Write-off not found or access denied | Списание не найдено или удалено |