API ЛК

Ключ API

Каждый запрос к API обязательно должен сопровождаться передачей авторизационного заголовка с токеном

Authorization: Bearer ЗНАЧЕНИЕ_ТОКЕНА

Идентификация сущностей

Главный идентификатором всех сущностей выступает UUID.

Все запросы на добавление/обновление/удаление сущностей отправляются HTTP-методом POST. При этом UUID указывается в адресе запроса, например: /entity/UUID/.

Типы запросов

Для разделения типов операций над сущностью в каждом запросе используется обязательное поле action.

Значение	Операция
delete	удаление
mark	установить пометку на удаление
unmark	снять пометку на удаление

По умолчанию, без указания action, считается, что отправляется запрос на добавление/обновление.

Справочники

Тип документа

Значение	Описание
contract	Договор
bill	Счет
attachment	Приложение
additional	Доп. соглашение
sales	Реализация товаров
completion	Акт выполненных работ
invoice	Счет фактура
reconciliation	Акт сверки взаиморасчетов

Статус документа

Значение	Описание
unsigned	Без подписи
signed-p	Подписан исполнителем
signed-с	Подписан заказчиком
signed	Подписан с двух сторон

Статус заказа

Значение	Описание
F	будущий заказ
A	активный заказ
D	завершенный заказ

Роли

Значение	Описание
manager	менеджер
assistant	ассистент

07 мая 2025