Различия

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

--- pd:develop:billingstore [2025/04/28 05:01]
127.0.0.1 внешнее изменение
+++ pd:develop:billingstore [2025/05/27 05:03] (текущий)
filatovnv
@@ Строка 57: / Строка 57: @@
         "phones": "9231234567;9231234568",
         "is_exemption" : "Y",
-        "is_no_paper_invoice": "Y"
+        "is_no_paper_invoice": "Y",
+        "locks": [ // Блокировка ЛС. Поле доступно, если в query передано account_num. Для расшифровки полей см раздел Блокировки.
+            {
+                "ail_id": "31",
+                "created_on_tz": "2025-05-15T09:07:37.211Z",
+                "updated_on_tz": "2025-05-15T09:41:49.803Z",
+                "partner_hash": "639959f4a1e37fe503843dcbd7e8a6e7",
+                "status": "0",
+                "lock_type": "2",
+                "func_arr": [
+                    "camera",
+                    "devaccess",
+                    "visitor_human",
+                    "visitor_auto",
+                    "nocontact_entry",
+                    "videophone"
+                ],
+                "note": "Апрель 2025, должники",
+                "updated_by_username": "Столыпина Марина",
+                "acc_note": "У вас есть задолженность по оплате коммунальных услуг в размере: %сумма%. Оплатите её, чтобы восстановить доступ ко всем возможностям приложения.",
+                "items": [
+                    {
+                        "aili_id": "1139",
+                        "ail_id": "31",
+                        "account_num": "210618100357",
+                        "phone": null,
+                        "status": "0",
+                        "updated_on_tz": "2025-05-15T09:36:58.904Z",
+                        "updated_by_username": "Столыпина Марина",
+                        "max_debt_amount": "20749.46"
+                    }
+                ]
+            }
+        ]
     },
 ]
@@ Строка 1175: / Строка 1208: @@
 </code>
+==== Блокировки лицевых счетов ====
+=== Получить список блокировок ===
+Пример запроса:
+GET domain.ru/locks?account_num=123&phone=9000000000&func_arr=camera,devaccess&start_date=2025-01-01&end_date=2025-01-01&limit=50&offset=0&statuses=0
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+[
+    {
+        "ail_id": "31",
+        "created_on_tz": "2025-05-15T09:07:37.211Z",
+        "updated_on_tz": "2025-05-15T09:41:49.803Z",
+        "partner_hash": "639959f4a1e37fe503843dcbd7e8a6e7",
+        "status": "0", // "0" - Активна, "1" - Не активна, "2" - удалена
+        "lock_type": "2", // "1" - Обычная блокировка, "2" - По сумме задолженности
+        "func_arr": [ // Enum блокируемых функций
+            "camera", // Просмотр камер
+            "devaccess", // Открытие по кнопке
+            "visitor_human", // Пропуска на вход
+            "visitor_auto", // Пропуска на въезд
+            "nocontact_entry", // Бесконтактный проход
+            "videophone" // Видеодомофония
+        ],
+        "note": "Апрель 2025, должники" // Заметка, отображаемая в CRM
+    }
+ ]
+</code>
+=== Получить детали блокировки ===
+Пример запроса:
+GET domain.ru/locks/:ail_id
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+{
+    "ail_id": "31",
+    "created_on_tz": "2025-05-15T09:07:37.211Z",
+    "updated_on_tz": "2025-05-15T09:41:49.803Z",
+    "partner_hash": "639959f4a1e37fe503843dcbd7e8a6e7",
+    "status": "0", // "0" - Активна, "1" - Не активна, "2" - удалена
+    "lock_type": "2", // "1" - Обычная блокировка, "2" - По сумме задолженности
+    "func_arr": [ // Enum блокируемых функций
+            "camera", // Просмотр камер
+            "devaccess", // Открытие по кнопке
+            "visitor_human", // Пропуска на вход
+            "visitor_auto", // Пропуска на въезд
+            "nocontact_entry", // Бесконтактный проход
+            "videophone" // Видеодомофония
+    ],
+    "note": "Апрель 2025, должники", // Заметка, отображаемая в CRM
+    "updated_by_username": "Иван Иванов",
+    "acc_note": "У вас есть задолженность по оплате коммунальных услуг в размере: %сумма%. Оплатите её, чтобы восстановить доступ ко всем возможностям приложения." // Уведомление для жителя
+}
+</code>
+=== Создать блокировку ===
+Пример запроса:
+POST domain.ru/locks
+<code javascript>
+{
+    "lock_type": "1", // "1" - Обычная блокировка, "2" - По сумме задолженности. Обязательное поле
+    "func_arr": ["camera"], // Enum блокируемых функций. "camera" - Просмотр камер, "devaccess" - Открытие по кнопке, "visitor_human" - Пропуска на вход, "visitor_auto" - Пропуска на въезд, "nocontact_entry" - Бесконтактный проход, "videophone" - Видеодомофония. Обязательное поле
+    "note": "Заметка", // Заметка, отображаемая в CRM. Не обязательное поле
+    "acc_note": "Уведомление для жителя" // Уведомление для жителя. Не обязательное поле
+}
+</code>
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+{"ok": true, "ail_id": "123"}
+</code>
+=== Редактировать блокировку ===
+Пример запроса:
+PUT domain.ru/locks/:ail_id
+<code javascript>
+{
+    "lock_type": "1", // "1" - Обычная блокировка, "2" - По сумме задолженности.
+    "func_arr": ["camera"], // Enum блокируемых функций. "camera" - Просмотр камер, "devaccess" - Открытие по кнопке, "visitor_human" - Пропуска на вход, "visitor_auto" - Пропуска на въезд, "nocontact_entry" - Бесконтактный проход, "videophone" - Видеодомофония.
+    "note": "Заметка", // Заметка, отображаемая в CRM.
+    "acc_note": "Уведомление для жителя" // Уведомление для жителя.
+}
+</code>
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+{"ok": true}
+</code>
+=== Список заблокированных клиентов ===
+Пример запроса:
+GET domain.ru/locks/:ail_id/items?statuses=0,1&account_num=123&phone=9000000000&limit=50&offset=0
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+[
+    {
+        "aili_id": "1140",
+        "ail_id": "31",
+        "account_num": "210618100359", // Номер ЛС
+        "phone": null, // Телефон
+        "status": "1", // "0" - Активна, "1" - Не активна, "2" - удалена
+        "updated_on_tz": "2025-05-22T11:07:31.925Z",
+        "updated_by_username": "Иван Иварнов",
+        "max_debt_amount": "27769.66" // Сумма задолженности для блокировки
+    },
+    {
+        "aili_id": "1140",
+        "ail_id": "31",
+        "account_num": null, // Номер ЛС
+        "phone": "210618100359", // Телефон
+        "status": "1", // "0" - Активна, "1" - Не активна, "2" - удалена
+        "updated_on_tz": "2025-05-22T11:07:31.925Z",
+        "updated_by_username": "Иван Иварнов",
+        "max_debt_amount": null
+    }
+]
+</code>
+=== Добавить заблокированного клиента ===
+Пример запроса:
+POST domain.ru/locks/:ail_id/items
+<code javascript>
+{
+    "account_num": "12443", // Обязательно, если нет phone
+    "phone": "9000000000", // Обязательно, если нет account_num
+    "status": 0, // "0" - Активна, "1" - Не активна, "2" - удалена. Не обязательное поле
+    "max_debt_amount": "300" // Сумма задолженности для блокировки. Не обязательное поле
+}
+</code>
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+{"ok": true, "aili_id": "123"}
+</code>
+=== Изменить заблокированного клиента ===
+Пример запроса:
+PUT domain.ru/locks/:ail_id/items/:aili_id
+<code javascript>
+{
+    "account_num": "12443",
+    "phone": "9000000000",
+    "status": 0, // "0" - Активна, "1" - Не активна, "2" - удалена.
+    "max_debt_amount": "300" // Сумма задолженности для блокировки.
+}
+</code>
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+{"ok": true}
+</code>
+=== Удалить заблокированного клиента ===
+Пример запроса:
+DELETE domain.ru/locks/:ail_id/items/:aili_id
+Пример ответа:
+<code javascript>
+// Ответ 200/ok
+{"ok": true}
+</code>