Деньги¶
Приходные и расходные ордера, входящие и исходящие платежи. Только чтение. Ордер — наличные, платёж — банк; в ответе они различаются набором полей.
Приходный ордер · cashin¶
GET /api/cashins¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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[].name |
int | Наименование документа (Значения: Приходный ордер, Касса (Наличные)) |
data[].type |
string | Тип документа (Значения: cashin) |
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[].purpose |
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[].vat |
float | Сумма НДС |
data[].company |
object | Организация |
data[].company.id |
int | Идентификатор организации |
data[].company.name |
int | Наименование организации |
data[].company.inn |
int | ИНН организации |
data[].company.kpp |
int | КПП организации |
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/cashins?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка приходных ордеров
HTTP code: 200
{
"meta": {
"allCount": "580",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 181,
"name": "Касса (Наличные)",
"type": "cashin",
"status": "1",
"number": "K-1",
"date": "2023-07-10",
"contractor": {
"id": 1,
"type": "ЮЛ",
"name": "ООО «Ромашка»",
"contactPerson": "Иванов Иван Иванович",
"inn": "7700000000",
"kpp": "770001001"
},
"purpose": "",
"comment": "Продажа № K-1",
"user": {
"type": "user",
"id": 2,
"name": "Петров П. П."
},
"created": "2023-07-10 09:37:44",
"edited": "2023-07-10 09:37:44",
"sum": 54441,
"vat": 0,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001"
},
"tree": [
{
"id": 256,
"created": "2023-07-10 09:37:44",
"name": "Отгрузка",
"type": "sale",
"status": 1,
"isThis": 0,
"childes": [
{
"id": 181,
"created": "2023-07-10 09:37:44",
"name": "Касса (Наличные)",
"type": "cashin",
"status": 1,
"isThis": 1
}
]
}
]
}
]
}
Входящий платеж · paymentin¶
GET /api/paymentins¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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[].name |
int | Наименование документа (Значения: Входящий платеж, Касса (Карточка)) |
data[].type |
string | Тип документа (Значения: paymentin) |
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[].purpose |
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[].vat |
float | Сумма НДС |
data[].company |
object | Организация |
data[].company.id |
int | Идентификатор организации |
data[].company.name |
int | Наименование организации |
data[].company.inn |
int | ИНН организации |
data[].company.kpp |
int | КПП организации |
data[].company.bankAccount |
object | Расчетный счет |
data[].company.bankAccount.id |
int | Идентификатор расчетного счета |
data[].company.bankAccount.name |
string | Наименование банка |
data[].company.bankAccount.bic |
string | БИК |
data[].company.bankAccount.correspondent_account |
string | Корр. счет |
data[].company.bankAccount.current_account |
string | Расчетный счет |
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/paymentins?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка входящих платежей
HTTP code: 200
{
"meta": {
"allCount": "171",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 214,
"name": "Входящий платеж",
"type": "paymentin",
"status": "1",
"number": "214",
"date": "2023-07-17",
"contractor": {
"id": 5,
"type": "ФЛ",
"name": "Иванов Иван Иванович",
"contactPerson": "Иванов Иван Иванович",
"inn": "",
"kpp": ""
},
"purpose": "",
"comment": "",
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2023-07-17 12:20:31",
"edited": "2023-07-17 12:20:31",
"sum": 69564,
"vat": 11594,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001",
"bankAccount": {
"id": "51",
"name": "ПАО «Банк»",
"bic": "044500000",
"correspondent_account": "30101810000000000000",
"current_account": "40702810000000000000"
}
},
"tree": [
{
"id": 274,
"created": "2023-07-17 12:20:22",
"name": "Заказ покупателя",
"type": "customerorder",
"status": 1,
"isThis": 0,
"childes": [
{
"id": 214,
"created": "2023-07-17 12:20:31",
"name": "Входящий платеж",
"type": "paymentin",
"status": 1,
"isThis": 1
}
]
}
]
}
]
}
Расходный ордер · cashout¶
GET /api/cashouts¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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[].name |
int | Наименование документа (Значения: Расходный ордер, Касса (Наличные)) |
data[].type |
string | Тип документа (Значения: cashout) |
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[].purpose |
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[].vat |
float | Сумма НДС |
data[].company |
object | Организация |
data[].company.id |
int | Идентификатор организации |
data[].company.name |
int | Наименование организации |
data[].company.inn |
int | ИНН организации |
data[].company.kpp |
int | КПП организации |
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/cashouts?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка расходных ордеров
HTTP code: 200
{
"meta": {
"allCount": "142",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 185,
"name": "Расходный ордер",
"type": "cashout",
"status": "1",
"number": "184",
"date": "2023-07-11",
"contractor": {
"id": 2,
"type": "ФЛ",
"name": "Иванов Иван Иванович",
"contactPerson": "Иванов Иван Иванович",
"inn": "",
"kpp": ""
},
"purpose": "",
"comment": "test rasxodniy order",
"user": {
"type": "user",
"id": 2,
"name": "Петров П. П."
},
"created": "2023-07-11 11:30:27",
"edited": "2023-07-11 11:30:27",
"sum": 100000,
"vat": 0,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001"
},
"tree": [
{
"id": 39,
"created": "2023-07-10 09:42:11",
"name": "Приемка",
"type": "purchase",
"status": 1,
"isThis": 0,
"childes": [
{
"id": 185,
"created": "2023-07-11 11:30:27",
"name": "Расходный ордер",
"type": "cashout",
"status": 1,
"isThis": 1
},
{
"id": 201,
"created": "2023-07-11 16:20:53",
"name": "Расходный ордер",
"type": "cashout",
"status": 1,
"isThis": 0
},
{
"id": 202,
"created": "2023-07-11 16:21:10",
"name": "Расходный ордер",
"type": "cashout",
"status": 1,
"isThis": 0
}
]
}
]
}
]
}
Исходящий платеж · paymentout¶
GET /api/paymentouts¶
Список записей с постраничной выборкой.
Параметры запроса
| Параметр | Тип | Ограничения |
|---|---|---|
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[].name |
int | Наименование документа (Значения: Исходящий платеж, Касса (Карточка)) |
data[].type |
string | Тип документа (Значения: paymentin) |
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[].purpose |
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[].vat |
float | Сумма НДС |
data[].company |
object | Организация |
data[].company.id |
int | Идентификатор организации |
data[].company.name |
int | Наименование организации |
data[].company.inn |
int | ИНН организации |
data[].company.kpp |
int | КПП организации |
data[].company.bankAccount |
object | Расчетный счет |
data[].company.bankAccount.id |
int | Идентификатор расчетного счета |
data[].company.bankAccount.name |
string | Наименование банка |
data[].company.bankAccount.bic |
string | БИК |
data[].company.bankAccount.correspondent_account |
string | Корр. счет |
data[].company.bankAccount.current_account |
string | Расчетный счет |
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/paymentouts?limit=10&offset=20&dateFrom=2025-05-12&dateTo=2025-09-12
Authorization: Bearer <ключ>
Ответ получения списка исходящих платежей
HTTP code: 200
{
"meta": {
"allCount": "78",
"count": 1,
"limit": 1,
"offset": 0
},
"data": [
{
"id": 217,
"name": "Исходящий платеж",
"type": "paymentout",
"status": "1",
"number": "217",
"date": "2023-07-25",
"contractor": {
"id": 4,
"type": "ЮЛ",
"name": "ООО «Ромашка»",
"contactPerson": "Иванов Иван Иванович",
"inn": "7700000000",
"kpp": "770001001"
},
"purpose": "",
"comment": "",
"user": {
"type": "admin",
"id": 1,
"name": "Петров П. П."
},
"created": "2023-07-25 10:44:30",
"edited": "2023-07-25 10:44:30",
"sum": 50000,
"vat": 8333.33,
"company": {
"id": 1,
"name": "ООО «Мастер»",
"inn": "7700000000",
"kpp": "770001001",
"bankAccount": {
"id": 51,
"name": "ПАО «Банк»",
"bic": "044500000",
"correspondent_account": "30101810000000000000",
"current_account": "40702810000000000000"
}
},
"tree": [
{
"id": 45,
"created": "2023-07-24 11:10:30",
"name": "Приемка",
"type": "purchase",
"status": 1,
"isThis": 0,
"childes": [
{
"id": 217,
"created": "2023-07-25 10:44:30",
"name": "Исходящий платеж",
"type": "paymentout",
"status": 1,
"isThis": 1
}
]
}
]
}
]
}