Возвраты¶
Возвраты поставщикам и возвраты покупателей. Только чтение.
Возврат поставщику · supplierreturn¶
GET /api/supplierreturns¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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/supplierreturns?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": 46,
"type": "supplierreturn",
"status": 1,
"number": "46",
"date": "2023-07-24",
"contractor": {
"id": 4,
"type": "ЮЛ",
"name": "ООО «Ромашка»",
"contactPerson": "Иванов Иван Иванович",
"inn": "7700000000",
"kpp": "770001001"
},
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "",
"vat": 1,
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2023-07-24 11:12:58",
"edited": "2023-07-24 11:12:58",
"sum": 100000,
"paid": 100000,
"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": 50000,
"pr_vat": 20,
"pr_discount": 0
}
],
"tree": {
"id": 46,
"created": "2023-07-24 11:12:58",
"name": "Возврат поставщику",
"type": "supplierreturn",
"status": 1,
"isThis": 1,
"childes": [
{
"id": 541,
"created": "2023-12-20 14:00:33",
"name": "Приходный ордер",
"type": "cashin",
"status": 1,
"isThis": 0
}
]
}
}
]
}
Возврат покупателя · customerreturn¶
GET /api/customerreturns¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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 | Тип документа (Значения: customerreturn) |
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[].fiscal |
int | Признак фискальности (Фиксируется при продаже из кассы с помощью фискального накопителя) (0 - Нефискальный, 1 - Фискальный) |
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/customerreturns?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка возвраты покупателей
HTTP code: 200
{
"meta": {
"allCount": "108",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 261,
"type": "customerreturn",
"status": 1,
"number": "261",
"date": "2023-07-11",
"contractor": null,
"stock": {
"id": 1,
"name": "Склад N1"
},
"comment": "Продажа № K-5",
"vat": 0,
"user": {
"type": "user",
"id": 2,
"name": "Петров П. П."
},
"created": "2023-07-11 13:41:40",
"edited": "2023-07-11 13:41:40",
"sum": 12098,
"paid": 12098,
"fiscal": 0,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001"
},
"products": [
{
"pr_id": 15009,
"pr_name": "Арматура гладкая А1 6 мм1111",
"pr_sku": "15009",
"pr_count": 0.2,
"pr_unit": {
"name": "т",
"code": "168"
},
"pr_price": 60490,
"pr_vat": 0,
"pr_discount": 0
}
],
"tree": [
{
"id": 260,
"created": "2023-07-11 13:41:23",
"name": "Отгрузка",
"type": "sale",
"status": 1,
"isThis": 0,
"childes": [
{
"id": 187,
"created": "2023-07-11 13:41:23",
"name": "Касса (Наличные)",
"type": "cashin",
"status": 1,
"isThis": 0
},
{
"id": 261,
"created": "2023-07-11 13:41:40",
"name": "Возврат покупателя",
"type": "customerreturn",
"status": 1,
"isThis": 1,
"childes": [
{
"id": 188,
"created": "2023-07-11 13:41:40",
"name": "Касса (Наличные)",
"type": "cashout",
"status": 1,
"isThis": 0
}
]
}
]
}
]
}
]
}