REST API приложения Оплата счетов онлайн

Проверка соединения

Используется для проверки соединения, получения наименования учетной системы и версии протокола.

Метод	Путь	Параметры	Ответ
GET	/hello	Нет	JSON

Возвращает JSON объект вида

{
"system" : "1С:Бухгалтерия",
"version" : "0.1.0"
}

Запрос списка счетов

Используется для поиска счетов к оплате в приложении.

Метод	Путь	Параметры	Ответ
GET	/list	name, number, date	JSON

Параметр	Тип	Описание
name	Строка	Часть наименования плательщика для поиска
number	Строка	Номер счета для поиска
date	Строка	В текущей версии протокола допускается одно значение `today` для поиска неоплаченных счетов только за сегодняшний день

Возвращает массив JSON с описанием списка счетов. Если счетов не найдено, возвращает пустой массив JSON.

[
	{
		"number": "УТ-27",
		"date": "31.01.2017",
		"id": "a5b3b78d-e78b-11e6-80c9-00259032bcdb",
		"customername": "ООО \"КЛИН-ЛАЙФ\"",
		"summ": 24941.73
	},
	{
		"number": "УТ-30",
		"date": "02.02.2017",
		"id": "71d9bc6b-e940-11e6-80c9-00259032bcdb",
		"customername": "ООО \"КЛИН-ЛАЙФ\"",
		"summ": 1567.98
	},
	{
		"number": "1",
		"date": "09.08.2017",
		"id": "6cd4b353-7d39-11e7-bed6-5453ed3ab335",
		"customername": "ООО \"ЛИНЕРИС\"",
		"summ": 1359.28
	}
]

Если учетная система допускает частичную оплату счетов, JSON объекты в массиве должны быть заполнены с учетом возможной частичной оплаты.

Запрос счета

Используется для получения информации, необходимой для формирования чека оплаты по счету.

Метод	Путь	Параметры	Ответ
GET	/bill/byid/<ID>	Нет	JSON

Ищет счет по <ID>, ранее полученному из списка счетов. Возвращает объект JSON с данными счета или пустой объект JSON.

{
	"number": "1",
	"date": "09.08.2017",
	"id": "6cd4b353-7d39-11e7-bed6-5453ed3ab335",
	"customer": {
		"name": "ЛИНЕРИС ООО",
		"id": "898ca024-afaa-11e6-80c4-00259032bcdb"
	},
	"products": [
		{
			"prodname": "Палочки для еды \"Кибори Яманами\"  22,5 см",
			"id": "97b0a2a0-8bae-11e6-80c1-00259032bcdb",
			"unitname": "шт",
			"taxrare": 18,
			"price": 65,
			"quantity": 15
		},
		{
			"prodname": "Mushiyoke Освежитель воздуха гелевый с ароматом лесных трав, 250 г",
			"id": "97b0a1cf-8bae-11e6-80c1-00259032bcdb",
			"unitname": "шт",
			"taxrare": 18,
			"price": 123,
			"quantity": 1
		},
		{
			"prodname": "Антибактериалный спрей для стульчака унитаза, 12 мл",
			"id": "97b0a295-8bae-11e6-80c1-00259032bcdb",
			"unitname": "шт",
			"taxrare": 18,
			"price": 122,
			"quantity": 2
		}
	],
	"summ": 1342
}

Если допускается частичная оплата счета, система учета должна сформировать объект JSON с учетом возможной частичной оплаты и передать в приложение только неоплаченную часть.

Получение информации об оплате

Используется для передачи информации по оплаченным счетам от приложения к учетной системе.

Метод	Путь	Параметры	Ответ
POST	/pay	billId, acquiring, summ, paymentId	JSON

Параметр	Тип	Описание
billId	Строка	Идентификатор счета в системе учета, полученный приложением через запрос списка счетов
acquiring	Логический	True если счет был оплачен картой, иначе False
summ	Число	Сумма оплаты, может отличаться от суммы счета в случае, если кассир при оплате применил скидку/наценку
paymentId	Строка	UUID оплаты в облаке Эвотор

Смарт-терминал Эвотор на текущий момент не поддерживает смешанную оплату чека, оплата полностью или наличными или эквайринг.

В ответ учетная система должна передать приложению JSON объект.

{
	"system": "Бухня",
	"protocol": "0.1.0"
}