Начало
Ниже представлены методы API для онлайн-сервиса Сметтер. Вы можете использовать данную документацию для обмена данными со сторонними ресурсами.
Для использования этого API необходоимо получить токен (ключ). Для получения свяжитесь со службой поддержки по электронной почте support@smetter.ru
Компании
Получение данных о компании для стартового экрана
GET /api/v1/company/home
Параметры запросов
| Field |
Type |
Description |
| companyId |
integer |
ID компании, данные о которой необходимо получить |
| type |
string |
роль пользователя: manager (менеджер) | customer (заказчик) | subcontractor (субподрядчик) |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение списка контрагентов компании
GET /api/v1/company/{id}/subcontractor-list
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer |
ID компании |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Склады
Список объектов компании, для которых можно создать приобъектный склад
GET /api/v1/company/{id}/equipment/available-for-attachment-project-list
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer |
ID компании |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Создание склада
POST /api/v1/company/{id}/create-warehouse
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| title |
string (formData) |
Название нового склада, использовать если нет project_id, то есть когда создается НЕ приобъектный склад |
| project_id |
integer (formData) |
ID объекта, использовать, если нет title, то есть когда создается приобъектный склад |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление склада
POST /api/v1/company/{id}/warehouse/{warehouseId}/close
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| warehouseId *required |
integer (path) |
ID удаляемого склада |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Общая информация о складских запасах: количество складских единиц и их общая стоимость
GET /api/v1/company/{id}/equipment/total-info
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Изменение статуса складской единицы
POST /api/v1/company/{id}/inventory/{inventoryGuid}/change-status
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid *required |
integer (path) |
GUID складской единицы |
| status |
integer (formData) |
Новый статус: (0; 1; 2; 3) |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Создание складской единицы
POST /api/v1/company/{id}/warehouse/{warehouseId}/create-inventory
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| warehouseId *required |
integer (path) |
ID склада |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Загрузка логов действий со складской единицей
GET /api/v1/company/{id}/inventory/{inventoryGuid}/load-log
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
| page |
integer (body) |
страница с логами |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Перенос складской единицы на другой склад
POST /api/v1/company/{id}/inventory/{inventoryGuid}/move
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
| to_warehouse_id |
integer (formData) |
ID склада назначения |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление складской единицы
DELETE /api/v1/company/{id}/inventory/{inventoryGuid}/remove
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Обновление даты "свободен" для складской единицы
POST /api/v1/company/{id}/inventory/{inventoryGuid}/update-free-date
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
| date |
string (formData) |
новая дата в формате YYYY-MM-DD |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Обновление данных о складской единице
POST /api/v1/company/{id}/inventory/{inventoryGuid}/update
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
| title |
string (formData) |
название складской единицы |
| inventory_number |
string (formData) |
инвентарный номер |
| purchase_date |
string (formData) |
дата покупки в формате YYYY-MM-DD |
| cost |
number (formData) |
стоимость |
| description |
string (formData) |
описание |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Загрузка фото
POST /api/v1/company/{id}/inventory/{inventoryGuid}/upload-photos
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
| files |
array [string] (formData) |
файлы фото |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение данных о складской единице
POST /api/v1/company/{id}/inventory/{inventoryGuid}/view
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение данных о складской единице
GET /api/v1/company/{id}/inventory/{inventoryGuid}/view
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| inventoryGuid |
string (path) |
GUID складской единицы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Перенос всех складских единиц с одного склада в другой
POST /api/v1/company/{id}/equipment/move-all-inventories
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| from_warehouse_id |
integer (formData) |
ID склада, с которого переносятся единицы |
| to_warehouse_id |
integer (formData) |
ID склада, на который переносятся единицы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Переименование склада (только для НЕ приобъектных)
POST /api/v1/company/{id}/warehouse/{warehouseId}/rename
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
| warehouseId |
integer (path) |
ID склада |
| title |
string (formData) |
Новое название склада |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Список складов и складских единиц со статусами
GET /_api/v1/company/{id}/equipment
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID компании |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Валюта
Получение списка валют
GET /api/v1/currency/list
Параметры запросов
| Field |
Type |
Description |
| no parameters |
|
|
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Справочники
Получение списка справочников
GET /api/v1/directory/list
Параметры запросов
| Field |
Type |
Description |
| companyId *required |
integer (body) |
ID компании |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Просмотр справочника
GET /api/v1/directory/{directoryId}/view
Параметры запросов
| Field |
Type |
Description |
| directoryId *required |
integer (path) |
ID справочника |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Смета
Добавление оплаты заказчика по смете
POST /api/v1/estimate/{estimateId}/add-payment
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Добавление пользователя к смете
POST /api/v1/estimate/{estimateId}/add-user/{role}
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| role *required |
string (path) |
роль пользователя: manager (менеджер) | customer (заказчик) | foreman (прораб) | buyer (закупщик) |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Архивирование сметы
POST /api/v1/estimate/{estimateId}/archivate
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление сметы
POST /api/v1/estimate/{estimateId}/delete
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 404 |
|
2002 |
| default |
application/json |
Returned when successful |
Учет НДС в смете
POST /api/v1/estimate/{estimateId}/margin
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| calculateVat |
string (formData) |
vat_included (НДС включен в стоимость позиций) | vat_added (НДС добавлен к стоимости позиций) | vat_not_included (без НДС) |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление пользователя из сметы
POST /api/v1/estimate/{estimateId}/new-remove-user/{email}/role/{role}
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| email *required |
string (path) |
email удаляемого пользователя |
| role *required |
string (path) |
какую роль пользователя следует удалить (пользователь может быть в нескольких ролях в смете): manager (менеджер) | customer (заказчик) | foreman (прораб) | buyer (закупщик) |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Переименование сметы
POST /api/v1/estimate/{estimateId}/rename
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| name |
string (formData) |
новое наименование сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Изменение валюты сметы
POST /api/v1/estimate/{estimateId}/update-currency
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| currency |
integer (formData) |
ID валюты из списка валют |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Включение или выключение возможности редактирования смет, находящихся в работе
POST /api/v1/estimate/{estimateId}/update-edit-mode
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| mode |
boolean (formData) |
флаг режима редактирования: 0 = редактирование невозможно, 1 = редактирование возможно |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Изменение статуса сметы
POST /api/v1/estimate/{estimateId}/update-status
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| status |
string (formData) |
новый статус сметы: draft (черновик) | on_agreement (на согласовании) | in_exploitations (в работе)| completed (завершена) |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение данных из сметы
GET /api/v1/estimate/{estimateId}/view
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 403 |
|
2002 |
| default |
application/json |
Returned when successful |
Получение списка позиций в смете для создания заявок на снабжение
GET /api/v1/estimate/{estimateId}/position-list-for-creating-supply-request
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 403 |
|
2002 |
| default |
application/json |
Returned when successful |
Работа со сметой заказчика
Добавление комментария для заказчика к смете
POST /api/v1/estimate/{estimateId}/customer/add-comment
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| text |
string (formData) |
текст комментария |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Согласование сметы заказчиком
POST /api/v1/estimate/{estimateId}/customer/approve
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Добавление комментария об оплате заказчика по смете
POST /api/v1/estimate/{estimateId}/customer/payment/create
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| comment |
string (formData) |
текст комментария |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение сметы заказчика в виде файла PDF
GET /api/v1/estimate/{estimateId}/customer/pdf
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление ранее внесенной оплаты заказчика
POST /api/v1/estimate/{id}/customer/payment/{paymentId}/remove
Параметры запросов
| Field |
Type |
Description |
| Id *required |
integer (path) |
ID сметы |
| paymentId *required |
integer (path) |
ID платежа |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Отправление заказчику извещение о готовности акта сдачи-приемки
POST /api/v1/estimate/{estimateId}/customer/report
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Отправление заказчику ссылку на смету по email
POST /api/v1/estimate/{estimateId}/customer/report
Параметры запросов
| Field |
Type |
Description |
| Id *required |
integer (path) |
ID сметы |
| email |
string (formData) |
email заказчика |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Обновление данных о платеже заказчика по смете
POST /api/v1/estimate/{id}/customer/payment/{paymentId}/update
Параметры запросов
| Field |
Type |
Description |
| Id *required |
integer (path) |
ID сметы |
| paymentId *required |
integer (path) |
ID платежа |
| comment |
string (formData) |
текст комментария |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение данных из сметы заказчика
GET /api/v1/estimate/{estimateId}/customer/view
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение сметы заказчика в виде файла xlsx
GET /api/v1/estimate/{estimateId}/customer/xlsx
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Чат (обсуждение сметы между заказчиком и менеджером)
Получение последнего сообшения из чата
GET /api/v1/estimate/{estimateId}/messages/last-update
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение всех сообщений чата
GET /api/v1/estimate/{estimateId}/message-list
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Отправка сообщения
POST /api/v1/estimate/{estimateId}/messages/send-message
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| text |
string (formData) |
текст комментария |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение сметы заказчика в виде файла PDF
GET /api/v1/estimate/{estimateId}/customer/pdf
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление сообщения
DELETE /api/v1/estimate/{estimateId}/message/{guid}/delete
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| guid *required |
string (path) |
GUID сообщения |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Создание позиций в определенных этапах сметы
Вставка группы позиций из справочника в определенный этап сметы
POST /api/v1/step/{stepId}/position/add-group-from-directory
Параметры запросов
| Field |
Type |
Description |
| stepId *required |
integer (path) |
ID этапа сметы |
| groupId |
integer (formData) |
ID группы в справочнике |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Создание позиции в определенном этапе
POST /api/v1/step/{stepId}/position/create
Параметры запросов
| Field |
Type |
Description |
| stepId *required |
integer (path) |
ID этапа сметы |
| name |
string (formData) |
наименование позиции |
| unit |
string (formData) |
единицы измерения |
| amount |
number (formData) |
количество |
| price |
number (formData) |
цена (себестоимость) за единицу |
| type |
integer (formData) |
тип позиции: (уточнить!) |
| margin |
integer (formData) |
наценка |
| customerPrice |
number (formData) |
цена для заказчика за единицу |
Ответы
| Code |
Type |
Description |
| 400 |
|
2001 |
| default |
application/json |
Returned when successful |
Действия с позициями сметы
Установка флага ГОТОВО у позиции
POST /api/v1/estimate/position/{positionId}/closed
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID позиции |
| closed |
boolean (formData) |
флаг: 0 = ничего | 1 = ГОТОВО |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление позиции
POST /api/v1/estimate/position/{positionId}/delete
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID позиции |
Ответы
| Code |
Type |
Description |
| 400 |
|
2001 |
| default |
application/json |
Returned when successful |
Скрытие количества и цены позиции в смете заказчика
POST /api/v1/estimate/position/{positionId}/hide-amount-and-prices
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID позиции |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Скрытие всей позиции в смете заказчика
POST /api/v1/estimate/position/{positionId}/hide-positions
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID позиции |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Установка позиции ключевой в группе
POST /api/v1/estimate/position/{positionId}/make-key-position
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID позиции |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Отказ от выполнения позиции (при статусе сметы В РАБОТЕ)
POST /api/v1/estimate/position/{positionId}/refuse
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID позиции |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Сортировка и группировка позиций и групп
POST /api/v1/estimate/position/sort
Параметры запросов
| Field |
Type |
Description |
| positionId |
integer (formData) |
ID позиции |
| newIndex |
integer (formData) |
новый индекс позиции |
| oldIndex |
integer (formData) |
старый индекс позиции |
| groupNewIndex |
integer (formData) |
новый индекс группы |
| groupOldIndex |
integer (formData) |
старый индекс группы |
| oldGroupId |
string (formData) |
старый ID группы |
| newGroupId |
string (formData) |
новый ID группы |
| newGroup |
boolean (formData) |
флаг создания новой группы: 0 = новая группа не создается | 1 = создается новая группа |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Обновление информации о позиции
POST /api/v1/estimate/position/{positionId}/update
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID позиции |
| name |
string (formData) |
наименование позиции |
| unit |
string (formData) |
единицы измерения |
| amount |
number (formData) |
количество |
| price |
number (formData) |
цена (себестоимость) за единицу |
| type |
integer (formData) |
тип позиции: (уточнить!) |
| margin |
integer (formData) |
наценка |
| closed |
boolean (formData) |
флаг: 0 = ничего | 1 = ГОТОВО |
Ответы
| Code |
Type |
Description |
| 400 |
|
2001 |
| default |
application/json |
Returned when successful |
Поиск данных в справочнике для вставки в позиции в определенной смете
GET /api/v1/estimate/{estimateId}/search-in-directories
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы, к которой относится позиция |
| query |
string (query) |
текст запроса |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Закупки по смете
Добавление и обновление чеков сметы
POST /api/v1/estimate/position/{positionId}/check/save
Параметры запросов
| Field |
Type |
Description |
| positionId *required |
integer (path) |
ID этапа сметы |
Ответы
| Code |
Type |
Description |
| 403 |
|
2002 |
| default |
application/json |
Returned when successful |
Добавление чека вручную
POST /api/v1/estimate/{estimateId}/purchase/add-receipt-manually
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| sum |
number (formData) |
сумма чека |
| date *required |
string (formData) |
дата приобретения |
| comment |
string (formData) |
комментарий к чеку |
Передача данных отсканированного чека
POST /api/v1/estimate/{estimateId}/purchase/scan-receipt
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| qrCodeData |
string (formData) |
данные из QR-кода |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Просмотр данных по закупкам
POST /api/v1/estimate/{estimateId}/purchase/scan-receipt
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 403 |
|
2002 |
| default |
application/json |
Returned when successful |
Данные о прогрессе по смете (виджеты)
Получение данных для графика
GET /api/v1/estimate/position/{positionId}/check/save
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение данных для сводной таблицы
GET /api/v1/estimate/{estimateId}/progress/total-widget
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Закупки сверх бюджета
Добавление закупочной позиции сверх бюджета
POST /api/v1/estimate/{estimateId}/purchase/excess/create
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| name |
string (formData) |
наименование позиции |
| amount |
integer (formData) |
количество |
| price |
number (formData) |
цена (себестоимость) за единицу |
| unit |
string (formData) |
единица измерения |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Удаление закупочной позиции сверх бюджета
POST /api/v1/estimate/purchase/excess/{excessId}/remove
Параметры запросов
| Field |
Type |
Description |
| excessId *required |
integer (path) |
ID позиции сверх бюджета |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Редактирование закупочной позиции сверх бюджета
POST /api/v1/estimate/purchase/excess/{excessId}/update
Параметры запросов
| Field |
Type |
Description |
| excessId *required |
integer (path) |
ID позиции сверх бюджета |
| name |
string (formData) |
наименование позиции |
| amount |
integer (formData) |
количество |
| price |
number (formData) |
цена (себестоимость) за единицу |
| unit |
string (formData) |
единица измерения |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Действия с этапами сметы
Редактирование наценок по типу позиции в этапе сметы
POST /api/v1/step/{stepId}/margin
Параметры запросов
| Field |
Type |
Description |
| stepId *required |
integer (path) |
ID этапа |
| defaultLaborMargin |
integer (formData) |
наценка на позиции типа "работы" |
| defaultMachineryMargin |
integer (formData) |
наценка на позиции типа "механизмы" |
| defaultMaterialMargin |
integer (formData) |
наценка на позиции типа "материалы" |
| defaultShippingMargin |
integer (formData) |
наценка на позиции типа "доставка" |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Estimate step margin items
POST /_api/v1/step/{stepId}/margin-items
Параметры запросов
| Field |
Type |
Description |
| stepId *required |
integer (path) |
ID этапа сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Работы по смете
Внесение данных об оплате работ (как с указанием субподрядчика, так и без него)
POST /api/v1/estimate/{estimateId}/work/create-paid
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| sum |
number (formData) |
сумма оплаты |
| subcontractorId |
integer (formData) |
ID субподрядчика |
| comment |
string (formData) |
комментарий к оплате |
| date |
string (formData) |
дата оплаты |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Создание заявки на оплату работ
POST /api/v1/estimate/{estimateId}/work/create-payment-request
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| sum |
number (formData) |
сумма оплаты |
| subcontractorId |
integer (formData) |
ID субподрядчика |
| comment |
string (formData) |
комментарий к оплате |
| date_pay_before |
string (formData) |
желаемая дата оплаты |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Внесение сведений о выполнении работ
POST /api/v1/estimate/{estimateId}/work/position/{positionId}/create-work
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| positionId *required |
integer (path) |
ID позиции, по которой вносятся сведения о работе |
| date |
string (formData) |
дата выполнения работ |
| subcontractorId |
integer (formData) |
ID субподрядчика, выполнившего работы |
| amount |
number (formData) |
объем выполнения |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Внесение сведений о закупке субподрядчика (чек, вручную)
POST /api/v1/estimate/{estimateId}/work/add-receipt-manually
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| sum |
number (formData) |
ID сумма чека |
| date *required |
string (formData) |
дата чека |
| comment |
string (formData) |
текст комментария к чеку |
| subcontractorId |
integer (formData) |
ID субпродрядчика |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение списка используемых в смете материалов и других ресурсов
GET /api/v1/estimate/{estimateId}/work/material-list
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 403 |
|
2002 |
| default |
application/json |
Returned when successful |
Получение списка чеков (закупок), произведенных по смете прорабами и субподрядиками
GET /api/v1/estimate/{id}/work/receipt-list
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление оплаты работ
POST /api/v1/estimate/{estimateId}/work/payment/{paymentId}/remove
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| paymentId *required |
integer (path) |
ID оплаты |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление чека
DELETE /api/v1/estimate/{id}/work/receipt/{receiptGuid}/remove
Параметры запросов
| Field |
Type |
Description |
| Id *required |
integer (path) |
ID сметы |
| receiptId *required |
string (path) |
ID чека |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Передача данных отсканированного чека, предоставленного прорабом или субподрядчиком
POST /api/v1/estimate/{estimateId}/work/scan-receipt
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| qrCodeData |
string (formData) |
данные из QR-кода |
| subcontractorID |
integer (formData) |
ID субподрядчика |
| comment |
string (formData) |
комментарий к чеку |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Обновление сведений об оплате за выполненные работы
POST /api/v1/estimate/{estimateId}/work/update-payment/{paymentId}
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| paymentId *required |
integer (path) |
ID оплаты |
| sum |
number (formData) |
сумма оплаты |
| subcontractorID |
integer (formData) |
ID субподрядчика |
| comment |
string (formData) |
комментарий к оплате |
| date |
string (formData) |
дата оплаты |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Обновление сведений о выполенной работе
POST /api/v1/estimate/{estimateId}/work/{workId}/update
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| workId *required |
integer (path) |
ID работы |
| date |
string (formData) |
дата производства работ |
| subcontractorID |
integer (formData) |
ID субподрядчика |
| amount |
integer (formData) |
объем произведенной работы |
Ответы
| Code |
Type |
Description |
| 400 |
|
3001 |
| default |
application/json |
Returned when successful |
Получение таблицы "Работы"
GET /api/v1/estimate/{estimateId}/work/view
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 403 |
|
2002 |
| default |
application/json |
Returned when successful |
Получение таблицы "Работы" для определенного субподрядчика
GET /api/v1/estimate/{estimateId}/subcontractor/{subcontractorId}/view
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| subcontractorId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| 403 |
|
2002 |
| default |
application/json |
Returned when successful |
Работы сверх бюджета
Создание записи о работе сверх бюджета
POST /api/v1/estimate/{estimateId}/work/extra/create
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| name |
string (formData) |
наименование |
| amount |
integer (formData) |
объем произведенной работы |
| price |
number (formData) |
цена (себестоимость) за единицу работы |
| unit |
string (formData) |
едигницы измерения |
| subcontractorID |
integer (formData) |
ID субподрядчика |
| date |
string (formData) |
дата производства работ в формате DD.MM.YYYY |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Удаление работы сверх бюджета
POST /api/v1/estimate/work/extra/{extraWorkId}/remove
Параметры запросов
| Field |
Type |
Description |
| extraWordId *required |
integer (path) |
ID работы сверх бюджета |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Обновление записи о работе сверх бюджета
POST /api/v1/estimate/work/extra/{extraWorkId}/update
Параметры запросов
| Field |
Type |
Description |
| extraWorkId *required |
integer (path) |
ID работы сверх бюджета |
| name |
string (formData) |
наименование |
| amount |
integer (formData) |
объем произведенной работы |
| price |
number (formData) |
цена (себестоимость) за единицу работы |
| unit |
string (formData) |
едигницы измерения |
| date |
string (formData) |
дата производства работ в формате DD.MM.YYYY |
Ответы
| Code |
Type |
Description |
| 404 |
|
2003 |
| default |
application/json |
Returned when successful |
Субподрядчики в смете
Добавление субподрядчика к смете
POST /api/v1/estimate/{estimateId}/add-subcontractor
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| name |
string (formData) |
наименование субподрядчика |
| email |
string (formData) |
почта субподрядчика |
| color |
string (formData) |
цвет для маркировки субподрядчика в смете, HEX без решетки |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Редактирование данных о субподрядчике в смете
POST /api/v1/estimate/{estimateId}/subcontractor/{subcontractorId}/update
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| subcontractorId *required |
integer (path) |
ID сметы |
| name |
string (formData) |
наименование субподрядчика |
| color |
string (formData) |
цвет для маркировки субподрядчика в смете, HEX без решетки |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление субподрядчика из сметы
POST /api/v1/estimate/{estimateId}/subcontractor/{subcontractorId}/remove
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| subcontractorId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление чека (закупки) относящегося к субподрядчику
DELETE /api/v1/estimate/{id}/work/subcontractor/{subcontractorId}/receipt/{receiptGuid}/remove
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| subcontractorId *required |
integer (path) |
ID сметы |
| receiptGuid *required |
string (path) |
ID чека |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение списка чеков (закупок) субподрядчика
GET /api/v1/estimate/{id}/subcontractor/{subcontractorId}/receipt-list
Параметры запросов
| Field |
Type |
Description |
| Id *required |
integer (path) |
ID сметы |
| subcontractorId *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Заявки на снабжение от субподрядчика
Создание заявки на снабжение от субподрядчика
POST /api/v1/estimate/{estimateId}/subcontractor/{subcontractorId}/work/create-supply-request
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| subcontractorId *required |
integer (path) |
ID субподрядчика |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение списка заявок, размещенных субподрядчиком
GET /api/v1/estimate/{id}/subcontractor/{subcontractorId}/work/supply-request-list
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID сметы |
| subcontractorId *required |
integer (path) |
ID субподрядчика |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Заявки на снабжение
Создание заявки на снабжение
POST /api/v1/estimate/{estimateId}/work/create-supply-request
Параметры запросов
| Field |
Type |
Description |
| estimateId *required |
integer (path) |
ID сметы |
| subcontractorId |
integer (formData) |
ID субподрядчика |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление размещенной заявки на снабжение
DELETE /api/v1/estimate/work/supply-request/{guid}/remove
Параметры запросов
| Field |
Type |
Description |
| guid *required |
string (path) |
ID заявки |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение списка размещенных заявок
GET /api/v1/estimate/{id}/work/supply-request-list
Параметры запросов
| Field |
Type |
Description |
| id *required |
integer (path) |
ID сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
База региональных рыночных расценок
Получение списка справочников базы, доступных компании
GET /api/v1/global-directory/list
Параметры запросов
| Field |
Type |
Description |
| companyId |
integer (query) |
ID компании |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Поиск в справочнике базы расценок
GET /api/v1/global-directory/{directoryId}/search
Параметры запросов
| Field |
Type |
Description |
| query |
string (query) |
поисковый запрос |
| directoryId *required |
string (path) |
ID справочника базы расценок |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Платежи
Получение данных о платежах и балансе счета подотчетных средств
GET /api/v1/company/{companyId}/personal-payments
Параметры запросов
| Field |
Type |
Description |
| companyId |
integer (query) |
ID компании |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Строительные объекты
Добавление менеджера объекта
POST /api/v1/project/{projectId}/add-manager
Параметры запросов
| Field |
Type |
Description |
| projectId |
integer (path) |
ID объекта |
| fio |
string (formData) |
ФИО менеджера |
| email |
string (formData) |
email менеджера |
| phone |
string (formData) |
телефон менеджера |
| need_add_in_estimates |
boolean (formData) |
признак "добавить во все сметы" |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Создание объекта
POST /api/v1/company/{companyId}/project/create
Параметры запросов
| Field |
Type |
Description |
| companyId *required |
integer (path) |
ID компании |
| name |
string (formData) |
наименование объекта |
| estimate_name |
string (formData) |
наименование создаваемой с объектом сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Создание сметы
POST /api/v1/project/{projectId}/create-estimate
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
| name |
string (formData) |
наименование сметы |
| currency |
integer (formData) |
ID валюты сметы |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Редактирование комментария к фотографии хода строительства
POST /api/v1/project/{projectId}/edit-step-by-step-photo/{photoId}
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
| photoId *required |
integer (path) |
ID фото |
| description |
string (formData) |
новый текст комментария |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение финансовой информации по объекту
GET /api/v1/project/{projectId}/finance-info
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Получение описания объекта
GET /api/v1/project/{projectId}/info
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление менеджера объекта
POST /api/v1/project/{projectId}/remove-manager/{projectManagerId}
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
| projectManagerId *required |
integer (path) |
ID менеджера |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Удаление фото хода строительства
POST /api/v1/project/{projectId}/remove-step-by-step-photo/{photoId}
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
| photoId *required |
integer (path) |
ID фото |
| date |
string (formData) |
дата совершения фото |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Обновление данных геолокации объекта
POST /api/v1/project/{projectId}/update-location
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
| address |
string (formData) |
адрес |
| latitude |
string (formData) |
широта |
| longitude |
string (formData) |
долгота |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Загрузка одной фотографии хода строительства
POST /api/v1/project/{projectId}/upload-step-by-step-photo
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
| date |
string (formData) |
дата совершения фото |
| description |
string (formData) |
текст описания фото |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
Загрузка нескольких фотографии хода строительства
POST /api/v1/project/{projectId}/upload-step-by-step-photos
Параметры запросов
| Field |
Type |
Description |
| projectId *required |
integer (path) |
ID объекта |
| dates |
array [string] (formData) |
дата совершения фото к каждой фото |
| description |
string (formData) |
текст описания фото (один для всех) |
Ответы
| Code |
Type |
Description |
| default |
application/json |
Returned when successful |
