Закупки¶
Заказы поставщикам, счета поставщиков и приёмки. Только чтение, параметры те же, что у продаж.
Заказ поставщику · supplierorder¶
GET /api/supplierorders¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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 | Тип документа (Значения: supplierorder) |
data[].status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].number |
string | Номер документа |
data[].date |
string | Дата документа (Формат: ГГГГ-ММ-ДД) |
data[].contractor |
object | Контрагент |
data[].contractor.id |
int | Идентификатор контрагента |
data[].contractor.type |
string | Тип контрагента (Значения: ЮЛ - Юр. лицо, ИП - Индивидуальный предприниматель, ФЛ - Физ. лицо) |
data[].contractor.name |
string | Наименование контрагента |
data[].contractor.contactPerson |
string | Контактное лицо |
data[].contractor.inn |
string | ИНН |
data[].contractor.kpp |
string | КПП |
data[].stock |
object | Склад / Точка продаж |
data[].stock.id |
int | Идентификатор склада |
data[].stock.name |
string | Наименование склада |
data[].comment |
string | Комментарий |
data[].vat |
int | Цена включает НДС (0 - нет, 1 - да) |
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[].paid |
float | Оплачено |
data[].company |
object | Организация |
data[].company.id |
int | Идентификатор организации |
data[].company.name |
int | Наименование организации |
data[].company.inn |
int | ИНН организации |
data[].company.kpp |
int | КПП организации |
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[].products.pr_vat |
int | ставка НДС (если 0 - без НДС) |
data[].products.pr_discount |
float | Процент (%) скидки |
data[].tree |
object | Структура зависимостей документа от связанных документов |
data[].tree.id |
int | Идентификатор документа верхнего уровня |
data[].tree.type |
string | Тип документа верхнего уровня (Значения: customerorder, customerinvoice, sale, customerreturn, supplierorder, supplierinvoice, purchase, supplierreturn, cashin, paymentin, cashout, paymentout, bonus) |
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_USER_ACCESS ERROR_NO_API_KEY
Запрос получения списка заказов поставщикам
Host: app.masterkassa.com
GET /api/supplierorders?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка заказов поставщикам
HTTP code: 200
{
"meta": {
"allCount": "12",
"count": 2,
"limit": 2,
"offset": 0
},
"data": [
{
"id": 114,
"type": "supplierorder",
"status": 1,
"number": "114",
"date": "2024-01-16",
"contractor": {
"id": 5,
"type": "ФЛ",
"name": "Иванов Иван Иванович",
"contactPerson": "Иванов Иван Иванович",
"inn": "",
"kpp": ""
},
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "",
"vat": 1,
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2024-01-16 16:26:06",
"edited": "2024-01-16 16:26:06",
"sum": 774600,
"paid": 0,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001"
},
"products": [
{
"pr_id": 15009,
"pr_name": "Арматура гладкая А1 6 мм1111",
"pr_sku": "15009",
"pr_count": 2,
"pr_unit": {
"name": "т",
"code": "168"
},
"pr_price": 37500,
"pr_vat": 20,
"pr_discount": 0
},
{
"pr_id": 12,
"pr_name": "Арматура гладкая А1 8 мм",
"pr_sku": "00139",
"pr_count": 3,
"pr_unit": {
"name": "т",
"code": "168"
},
"pr_price": 59000,
"pr_vat": 20,
"pr_discount": 0
}
],
"tree": {
"id": 114,
"created": "2024-01-16 16:26:06",
"name": "Заказ поставщику",
"type": "supplierorder",
"status": 1,
"isThis": 1,
"childes": [
{
"id": 115,
"created": "2024-01-16 16:26:20",
"name": "Закупка",
"type": "purchase",
"status": 1,
"isThis": 0,
"childes": []
},
{
"id": 117,
"created": "2024-01-16 16:35:26",
"name": "Закупка",
"type": "purchase",
"status": 1,
"isThis": 0,
"childes": []
}
]
}
}
]
}
// пример сокращён: показаны не все записи
Счет поставщика · supplierinvoice¶
GET /api/supplierinvoices¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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 | Тип документа (Значения: customerinvoice) |
data[].status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].number |
string | Номер документа |
data[].date |
string | Дата документа (Формат: ГГГГ-ММ-ДД) |
data[].contractor |
object | Контрагент |
data[].contractor.id |
int | Идентификатор контрагента |
data[].contractor.type |
string | Тип контрагента (Значения: ЮЛ - Юр. лицо, ИП - Индивидуальный предприниматель, ФЛ - Физ. лицо) |
data[].contractor.name |
string | Наименование контрагента |
data[].contractor.contactPerson |
string | Контактное лицо |
data[].contractor.inn |
string | ИНН |
data[].contractor.kpp |
string | КПП |
data[].stock |
object | Склад / Точка продаж |
data[].stock.id |
int | Идентификатор склада |
data[].stock.name |
string | Наименование склада |
data[].comment |
string | Комментарий |
data[].vat |
int | Цена включает НДС (0 - нет, 1 - да) |
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[].paid |
float | Оплачено |
data[].company |
object | Организация |
data[].company.id |
int | Идентификатор организации |
data[].company.name |
int | Наименование организации |
data[].company.inn |
int | ИНН организации |
data[].company.kpp |
int | КПП организации |
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[].products.pr_vat |
int | ставка НДС (если 0 - без НДС) |
data[].products.pr_discount |
float | Процент (%) скидки |
data[].tree |
object | Структура зависимостей документа от связанных документов |
data[].tree.id |
int | Идентификатор документа верхнего уровня |
data[].tree.type |
string | Тип документа верхнего уровня (Значения: customerorder, customerinvoice, sale, customerreturn, supplierorder, supplierinvoice, purchase, supplierreturn, cashin, paymentin, cashout, paymentout, bonus) |
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/supplierinvoices?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка счета поставщиков
HTTP code: 200
{
"meta": {
"allCount": "11",
"count": 2,
"limit": 2,
"offset": 0
},
"data": [
{
"id": 121,
"type": "supplierinvoice",
"status": 1,
"number": "120",
"date": "2024-01-17",
"contractor": {
"id": 8,
"type": "ФЛ",
"name": "Иванов Иван Иванович",
"contactPerson": "Иванов Иван Иванович",
"inn": "",
"kpp": ""
},
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "На основе Заказ поставщику № 120",
"vat": 1,
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2024-01-17 10:53:03",
"edited": "2024-01-17 10:53:03",
"sum": 748400,
"paid": 748400,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001"
},
"products": [
{
"pr_id": 19,
"pr_name": "Арматура гладкая А1 14 мм",
"pr_sku": "00142",
"pr_count": 5,
"pr_unit": {
"name": "т",
"code": "168"
},
"pr_price": 58500,
"pr_vat": 20,
"pr_discount": 0
},
{
"pr_id": 10,
"pr_name": "Арматура гладкая А1 16 мм",
"pr_sku": "00143",
"pr_count": 5,
"pr_unit": {
"name": "т",
"code": "168"
},
"pr_price": 46490,
"pr_vat": 20,
"pr_discount": 0
},
{
"pr_id": 13,
"pr_name": "Арматура гладкая А1 18 мм",
"pr_sku": "00144",
"pr_count": 5,
"pr_unit": {
"name": "т",
"code": "168"
},
"pr_price": 44690,
"pr_vat": 20,
"pr_discount": 0
}
],
"tree": {
"id": 121,
"created": "2024-01-17 10:53:03",
"name": "Счет поставщика",
"type": "supplierinvoice",
"status": 1,
"isThis": 1,
"childes": []
}
}
]
}
// пример сокращён: показаны не все записи
Приемка · purchase¶
GET /api/purchases¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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 | Тип документа (Значения: purchase) |
data[].status |
int | Статус документа (0 - Не проведено, 1 - Проведено) |
data[].number |
string | Номер документа |
data[].date |
string | Дата документа (Формат: ГГГГ-ММ-ДД) |
data[].contractor |
object | Контрагент |
data[].contractor.id |
int | Идентификатор контрагента |
data[].contractor.type |
string | Тип контрагента (Значения: ЮЛ - Юр. лицо, ИП - Индивидуальный предприниматель, ФЛ - Физ. лицо) |
data[].contractor.name |
string | Наименование контрагента |
data[].contractor.contactPerson |
string | Контактное лицо |
data[].contractor.inn |
string | ИНН |
data[].contractor.kpp |
string | КПП |
data[].stock |
object | Склад / Точка продаж |
data[].stock.id |
int | Идентификатор склада |
data[].stock.name |
string | Наименование склада |
data[].comment |
string | Комментарий |
data[].vat |
int | Цена включает НДС (0 - нет, 1 - да) |
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[].paid |
float | Оплачено |
data[].company |
object | Организация |
data[].company.id |
int | Идентификатор организации |
data[].company.name |
int | Наименование организации |
data[].company.inn |
int | ИНН организации |
data[].company.kpp |
int | КПП организации |
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[].products.pr_vat |
int | ставка НДС (если 0 - без НДС) |
data[].products.pr_discount |
float | Процент (%) скидки |
data[].tree |
object | Структура зависимостей документа от связанных документов |
data[].tree.id |
int | Идентификатор документа верхнего уровня |
data[].tree.type |
string | Тип документа верхнего уровня (Значения: customerorder, customerinvoice, sale, customerreturn, supplierorder, supplierinvoice, purchase, supplierreturn, cashin, paymentin, cashout, paymentout, bonus) |
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/purchases?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка приемок
HTTP code: 200
{
"meta": {
"allCount": "1",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 268,
"type": "purchase",
"status": 1,
"number": "268",
"date": "2025-10-19",
"contractor": {
"id": 72,
"type": "ФЛ",
"name": "Иванов Иван Иванович",
"contactPerson": "Иванов Иван Иванович",
"inn": "",
"kpp": ""
},
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "",
"vat": 1,
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2025-10-19 23:28:02",
"edited": "2025-10-19 23:30:45",
"sum": 295000,
"paid": 295000,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001"
},
"products": [
{
"pr_id": 17164,
"pr_name": "Покраска",
"pr_sku": "17162",
"pr_count": 3,
"pr_unit": {
"name": "шт",
"code": "796"
},
"pr_price": 75000,
"pr_vat": 0,
"pr_discount": 0
},
{
"pr_id": 17166,
"pr_name": "Нарезание резьбы",
"pr_sku": "17164",
"pr_count": 2,
"pr_unit": {
"name": "шт",
"code": "796"
},
"pr_price": 35000,
"pr_vat": 20,
"pr_discount": 0
}
],
"tree": {
"id": 268,
"created": "2025-10-19 23:28:02",
"name": "Приемка",
"type": "purchase",
"status": 1,
"isThis": 1,
"childes": [
{
"id": 1632,
"created": "2025-10-19 23:35:52",
"name": "Исходящий платеж",
"type": "paymentout",
"status": 1,
"isThis": 0
}
]
}
}
]
}
// пример сокращён: показаны не все записи