Расчёт остатков¶
Оприходования, списания и инвентаризации — документы, которыми меняют остаток на складе. Только чтение.
Оприходование · enter¶
GET /api/enters¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
limit |
int | диапазон 1..50, по умолчанию 50 |
offset |
int | по умолчанию 0 |
dateFrom |
date | формат YYYY-MM-DD |
dateTo |
date | формат YYYY-MM-DD |
status |
int | значения 0, 1, не передан — вернутся все |
Коды ответа
| Код | Что значит |
|---|---|
200 |
успешный |
401 |
нет доступа: ключ не передан, просрочен или неверен |
400 |
неверный запрос: не хватает параметра или он не того типа |
Поля ответа
| Поле | Тип | Значение |
|---|---|---|
meta |
object | Метаданные о выдаче |
meta.allCount |
int | Количество всех элементов |
meta.count |
int | Размер выданного списка |
meta.limit |
int | Максимальное количество элементов в выданном списке. Максимальное количество элементов в списке равно 50. |
meta.offset |
int | Отступ в выданном списке |
data |
array (object) | Массив JSON объектов, представляющих собой оприходование. |
data[].id |
int | Идентификатор документа |
data[].type |
string | Тип документа (Значения: enter) |
data[].status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].number |
string | Номер документа |
data[].date |
string | Дата документа (Формат: ГГГГ-ММ-ДД) |
data[].stock |
object | Склад / Точка продаж |
data[].stock.id |
int | Идентификатор склада |
data[].stock.name |
string | Наименование склада |
data[].comment |
string | Комментарий |
data[].user |
object | Фактический адрес |
data[].user.id |
int | Идентификатор пользователя |
data[].user.type |
string | Тип пользователя ('admin' - Администратор, 'user' - Сотрудник) |
data[].user.name |
string | Наименование пользователя |
data[].created |
string | Дата и время создания документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].edited |
string | Дата и время изменения документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].sum |
float | Общая сумма документа |
data[].products |
array (object) | Массив товаров |
data[].products.pr_id |
int | Идентификатор товара |
data[].products.pr_name |
string | Наименование товара |
data[].products.pr_sku |
string | Артикул товара |
data[].products.pr_count |
float | Количество товара |
data[].products.pr_unit |
object | Ед. измерения |
data[].products.pr_unit.name |
string | Наименование ед. измерения |
data[].products.pr_unit.code |
string | Код ед. измерения |
data[].products.pr_price |
float | Цена товара |
data[].tree |
object | Структура зависимостей документа от связанных документов |
data[].tree.id |
int | Идентификатор документа верхнего уровня |
data[].tree.type |
string | Тип документа верхнего уровня (Значения: inventory, enter, loss) |
data[].tree.name |
string | Наименование документа (Значения: Инвентаризация, Оприходование, Списание |
data[].tree.created |
string | Дата и время создания документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].tree.status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].tree.isThis |
int | Логический флаг, указывающий, является ли документ текущим (активным). (0 - нет, 1 - да) |
data[].tree.childes |
array (object) | Массив объектов tree |
Ошибки
ERROR_LIMIT ERROR_OFFSET ERROR_DATEFROM ERROR_DATETO ERROR_STATUS ERROR_USER_ACCESS ERROR_NO_API_KEY
Запрос получить список оприходований
Host: app.masterkassa.com
GET /api/enters?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получить список оприходований
HTTP code: 200
{
"meta": {
"allCount": "21",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 5,
"type": "enter",
"status": "1",
"number": "1",
"date": "2023-07-17",
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "",
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2023-07-17 11:02:06",
"edited": "2023-07-17 11:02:06",
"sum": 146148.78,
"products": [],
"tree": [
{
"id": 5,
"created": "2023-07-17 11:02:06",
"name": "Оприходование",
"type": "enter",
"status": 1,
"isThis": 1
}
]
}
]
}
Списание · loss¶
GET /api/losses¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
limit |
int | диапазон 1..50, по умолчанию 50 |
offset |
int | по умолчанию 0 |
dateFrom |
date | формат YYYY-MM-DD |
dateTo |
date | формат YYYY-MM-DD |
status |
int | значения 0, 1, не передан — вернутся все |
Коды ответа
| Код | Что значит |
|---|---|
200 |
успешный |
401 |
нет доступа: ключ не передан, просрочен или неверен |
400 |
неверный запрос: не хватает параметра или он не того типа |
Поля ответа
| Поле | Тип | Значение |
|---|---|---|
meta |
object | Метаданные о выдаче |
meta.allCount |
int | Количество всех элементов |
meta.count |
int | Размер выданного списка |
meta.limit |
int | Максимальное количество элементов в выданном списке. Максимальное количество элементов в списке равно 50. |
meta.offset |
int | Отступ в выданном списке |
data |
array (object) | Массив JSON объектов, представляющих собой списание. |
data[].id |
int | Идентификатор документа |
data[].type |
string | Тип документа (Значения: loss) |
data[].status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].number |
string | Номер документа |
data[].date |
string | Дата документа (Формат: ГГГГ-ММ-ДД) |
data[].stock |
object | Склад / Точка продаж |
data[].stock.id |
int | Идентификатор склада |
data[].stock.name |
string | Наименование склада |
data[].comment |
string | Комментарий |
data[].user |
object | Фактический адрес |
data[].user.id |
int | Идентификатор пользователя |
data[].user.type |
string | Тип пользователя ('admin' - Администратор, 'user' - Сотрудник) |
data[].user.name |
string | Наименование пользователя |
data[].created |
string | Дата и время создания документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].edited |
string | Дата и время изменения документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].sum |
float | Общая сумма документа |
data[].products |
array (object) | Массив товаров |
data[].products.pr_id |
int | Идентификатор товара |
data[].products.pr_name |
string | Наименование товара |
data[].products.pr_sku |
string | Артикул товара |
data[].products.pr_count |
float | Количество товара |
data[].products.pr_unit |
object | Ед. измерения |
data[].products.pr_unit.name |
string | Наименование ед. измерения |
data[].products.pr_unit.code |
string | Код ед. измерения |
data[].products.pr_price |
float | Цена товара |
data[].tree |
object | Структура зависимостей документа от связанных документов |
data[].tree.id |
int | Идентификатор документа верхнего уровня |
data[].tree.type |
string | Тип документа верхнего уровня (Значения: inventory, enter, loss) |
data[].tree.name |
string | Наименование документа (Значения: Инвентаризация, Оприходование, Списание |
data[].tree.created |
string | Дата и время создания документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].tree.status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].tree.isThis |
int | Логический флаг, указывающий, является ли документ текущим (активным). (0 - нет, 1 - да) |
data[].tree.childes |
array (object) | Массив объектов tree |
Ошибки
ERROR_LIMIT ERROR_OFFSET ERROR_DATEFROM ERROR_DATETO ERROR_STATUS ERROR_USER_ACCESS ERROR_NO_API_KEY
Запрос получить список списаний
Host: app.masterkassa.com
GET /api/losses?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получить список списаний
HTTP code: 200
{
"meta": {
"allCount": "5",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 71,
"type": "loss",
"status": "1",
"number": "71",
"date": "2025-06-04",
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "Инвентаризации № 69",
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2025-06-04 14:30:37",
"edited": "2025-11-21 10:03:17",
"sum": 228528,
"products": [],
"tree": [
{
"id": 71,
"created": "2025-06-04 14:30:37",
"name": "Инвентаризация",
"type": "inventory",
"status": 1,
"isThis": 0,
"childes": [
{
"id": 70,
"created": "2025-06-04 14:30:26",
"name": "Оприходование",
"type": "enter",
"status": 1,
"isThis": 0
},
{
"id": 71,
"created": "2025-06-04 14:30:37",
"name": "Списание",
"type": "loss",
"status": 1,
"isThis": 1
}
]
}
]
}
]
}
Инвентаризация · inventory¶
GET /api/inventories¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
limit |
int | диапазон 1..50, по умолчанию 50 |
offset |
int | по умолчанию 0 |
dateFrom |
date | формат YYYY-MM-DD |
dateTo |
date | формат YYYY-MM-DD |
status |
int | значения 0, 1, не передан — вернутся все |
Коды ответа
| Код | Что значит |
|---|---|
200 |
успешный |
401 |
нет доступа: ключ не передан, просрочен или неверен |
400 |
неверный запрос: не хватает параметра или он не того типа |
Поля ответа
| Поле | Тип | Значение |
|---|---|---|
meta |
object | Метаданные о выдаче |
meta.allCount |
int | Количество всех элементов |
meta.count |
int | Размер выданного списка |
meta.limit |
int | Максимальное количество элементов в выданном списке. Максимальное количество элементов в списке равно 50. |
meta.offset |
int | Отступ в выданном списке |
data |
array (object) | Массив JSON объектов, представляющих собой инвентаризация. |
data[].id |
int | Идентификатор документа |
data[].type |
string | Тип документа (Значения: inventory) |
data[].status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].number |
string | Номер документа |
data[].date |
string | Дата документа (Формат: ГГГГ-ММ-ДД) |
data[].stock |
object | Склад / Точка продаж |
data[].stock.id |
int | Идентификатор склада |
data[].stock.name |
string | Наименование склада |
data[].comment |
string | Комментарий |
data[].user |
object | Фактический адрес |
data[].user.id |
int | Идентификатор пользователя |
data[].user.type |
string | Тип пользователя ('admin' - Администратор, 'user' - Сотрудник) |
data[].user.name |
string | Наименование пользователя |
data[].created |
string | Дата и время создания документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].edited |
string | Дата и время изменения документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].sum |
float | Общая сумма документа |
data[].products |
array (object) | Массив товаров |
data[].products.pr_id |
int | Идентификатор товара |
data[].products.pr_name |
string | Наименование товара |
data[].products.pr_sku |
string | Артикул товара |
data[].products.pr_count |
float | Количество товара |
data[].products.pr_unit |
object | Ед. измерения |
data[].products.pr_unit.name |
string | Наименование ед. измерения |
data[].products.pr_unit.code |
string | Код ед. измерения |
data[].products.pr_price |
float | Цена товара |
data[].tree |
object | Структура зависимостей документа от связанных документов |
data[].tree.id |
int | Идентификатор документа верхнего уровня |
data[].tree.type |
string | Тип документа верхнего уровня (Значения: inventory, enter, loss) |
data[].tree.name |
string | Наименование документа (Значения: Инвентаризация, Оприходование, Списание |
data[].tree.created |
string | Дата и время создания документа (Формат: ГГГГ-ММ-ДД ЧЧ:ММ:СС) |
data[].tree.status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].tree.isThis |
int | Логический флаг, указывающий, является ли документ текущим (активным). (0 - нет, 1 - да) |
data[].tree.childes |
array (object) | Массив объектов tree |
Ошибки
ERROR_LIMIT ERROR_OFFSET ERROR_DATEFROM ERROR_DATETO ERROR_STATUS ERROR_USER_ACCESS ERROR_NO_API_KEY
Запрос получить список инвентаризаций
Host: app.masterkassa.com
GET /api/inventories?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получить список инвентаризаций
HTTP code: 200
{
"meta": {
"allCount": "2",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 69,
"type": "inventory",
"status": "1",
"number": "68",
"date": "2025-06-04",
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "",
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2025-06-04 14:29:56",
"edited": "2025-06-04 14:30:16",
"sum": 35850000,
"products": [],
"tree": [
{
"id": 69,
"created": "2025-06-04 14:29:56",
"name": "Инвентаризация",
"type": "inventory",
"status": 1,
"isThis": 1,
"childes": [
{
"id": 70,
"created": "2025-06-04 14:30:26",
"name": "Оприходование",
"type": "enter",
"status": 1,
"isThis": 0
},
{
"id": 71,
"created": "2025-06-04 14:30:37",
"name": "Списание",
"type": "loss",
"status": 1,
"isThis": 0
}
]
}
]
}
]
}