Водяной

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
===Клиенты - работа со списками и записями===
==Список клиентов==
Пример запроса (записи не более 2 клиентов, созданных или обновленных после 1 января 2020 г.):
<code>
GET http://127.0.0.1:10400/api/clients?updated_gte="01.01.2020"&limit=2
</code>

Ответ:
<code>
{
    "result": [
        {
            "ID": "1000000000001",
            "NAIMENOVANIE": "Буняковский Виктор Яковлевич ИП",
            "TELEFON": "71112223311",
            "DSZD": "24.03.2019 9:39:30",
            "DATAIZM": "12.01.2020 14:16:25",
            "DISP": "1000000000010"
        },
        {
            "ID": "1000000000002",
            "NAIMENOVANIE": "Андрей  - Научная ул,24, кв.41",
            "TELEFON": "78881112233",
            "DSZD": "24.03.2019 9:40:45",
            "DATAIZM": "02.03.2020 14:54:11",
            "DISP": "1000000000010"
        }
    ],
    "limit": 2,
    "total": 2
}
</code>
Поля:
ID - Уникальный идентификатор (код записи)\\
NAIMENOVANIE - Имя/Наименование клиента\\
TELEFON - Номер телефона (общий по клиенту)\\
DOP_SC - Дополнительные сведения (комментарий по клиенту)\\
EMAIL - Электронная почта\\
DSZD - Дата создания\\
DATAIZM - Дата последнего обновления \\
DISP - ответственный за клиента (код из справочника сотрудников)\\
Состав полей может отличаться от приведенного, пустые значения не передаются.\\

==Получить реквизиты контрагента по его коду==
GET /clients/:id
Пример
<code>
GET http://127.0.0.1:10400/api/clients/1000000000048
</code>
Ответ 
<code>
{    "result": {"ID": "1000000000048",
        "NAIMENOVANIE": "339-й Стрелковой Дивизии ул,123, кв.33",
        "TELEFON": "78124243353",
        "DSZD": "30.11.2019 11:30:19",
        "DATAIZM": "21.01.2020 7:27:43",
        "DISP": "1000000000001"}}
</code>

==Получить задолженность контрагента==

GET /clients/:id/balance
Пример
<code>
GET http://127.0.0.1:10400/api/clients/1000000000048/balance
</code>
Ответ 
<code>
{"result": 100.00}
</code>
Возвращаемое значение - ДОЛГ клиента на утро текущего дня (без учета отгрузок и платежей, проведенных текущим днем). Отрицательное значение возвращается, если есть предоплата.

==Получить сумму бонусов на счету контрагента (в рублях)==

GET /clients/:id/bonus
Пример
<code>
GET http://127.0.0.1:10400/api/clients/1000000000048/bonus
</code>
Ответ 
<code>
{"result": 45.99}
</code>
Возвращаемое значение - сумма бонусов на счету клиента на утро текущего дня (без учета отгрузок и платежей, проведенных текущим днем). 


==Получить данные контрагента по номеру телефона==
GET /clients?tel=номер
Пример
<code>
http://127.0.0.1:10400/api/clients?tel=71112794311
</code>
Ответ 
<code>
    "result": {
        "id": "1000000000001",
        "naimenovanie": "Буняковский Виктор Яковлевич ИП",
        "vidpom": "1000000000001",
        "pod": "55",
        "kodpod": "111",
        "et": "0",
        "telefon": "71112794311",
        "dsvpln": "Не привезли 11.03.2022 0x*Вода 19 литров",
        "fam": "Буняковский",
        "imja": "Виктор",
        "otchestvo": "Яковлевич",
        "chast": "5",
        "posldst": "23.01.2022",
        "pslknt": "07.11.2021",
        "katdst": "1000000000001",
        "klvof": "0",
        "ochered": "1",
        "shirota": "47.236136",
        "dolgota": "39.833379",
        "poslnakl": "11.02.2022",
        "pervnakl": "30.05.2019",
        "adrsvodnakl": "0",
        "autor": "1000000000001",
        "dszd": "24.03.2019 9:39:30",
        "redakt": "1000000000002",
        "dataizm": "08.09.2021 9:57:31",
        "eto_gruppa": "0",
        "vidkontr": "1000000000001",
        "disp": "1000000000010",
        "tipcen": "1000000000001",
        "rekkam": "1000000000004",
        "frmras": "1000000000001",
        "firma": "1000000000001",
        "polnoenaimenovanie": "Буняковский Виктор Яковлевич ИП",
        "adresur": "Краеведческая ул,51, кв.150",
        "adresfakt": "Краеведческая ул,51, кв.150",
        "nomer_karty": "1",
        "idu4sed": "1000000000001",
        "datapech": "24.03.2019",
        "osnt12": "основной договор",
        "pchtkubut": "0",
        "katptrb": "1000000000001",
        "segmentptr": "1000000000001",
        "statuskl": "1000000000004",
        "pchtupdbezprosl": "0"
    }
}
</code>
Возвращаемое значение - данные контрагента и того адреса доставки (кроме кода) , к которому относится телефон.\\

==Получить данные контрагента по паролю или контрольной сумме во внешнем приложении==
GET /clients?psw=пароль
Пример
<code>
http://127.0.0.1:10400/api/clients?psw=VGhlIHF1aWNrIGJyb3duI
</code>

Если клиент найден, возвращаются его данные

<code>
{    "result": {"ID": "1000000000048",
        "NAIMENOVANIE": "339-й Стрелковой Дивизии ул,123, кв.33",
        "TELEFON": "78124243353",
        "DSZD": "30.11.2019 11:30:19",
        "DATAIZM": "21.01.2020 7:27:43",
        "DISP": "1000000000001"}}
</code>


Если подходящего клиента нет, возвращается 404 и пустая запись.
<code>
{    "result": {}}
</code>



==Создать контрагента и основной адрес==
<code>
POST http://127.0.0.1:10400/api/clients
</code>

тело запроса (JSON):
<code>
{"naimenovanie":"Иванов Иван Иванович", 
"dop_sv":"один хороший человек", 
"telefon":"78632171717 Иван Иванович, 79182323121 Елена Петровна",
"ulica":1000000000011,
"dom":"22Б стр.3",
"korpus":"1",
"kv":"1",
"email":"ivanov@test.tt",
"etoof":0,
"commvod":"зеленые ворота у 'А&Б'",
"commdisp":"звонить строго до 21-00!!!",
"psw": "VGhlIHF1aWNrIGJyb3duI"
}
</code>


ответ
<code>
{"result": 1000000000092,"adr": 1000000000084}
</code>
Здесь 1000000000092 - код нового контрагента, 1000000000084 - код его основного адреса \\ 
Если передан параметр psw, будет сохранен хэш от этого значения для поиска клиента при вызове метода  /api/clients?psw\\


==Изменить реквизиты клиента==
PATCH /clients/:id
Пример
<code>
http://127.0.0.1:10400/api/clients/1000000000060
</code>
Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы).
<code>
{"naimenovanie":"Торговый дом 'Сидоров и сыновья'", "dop_sv":"Проверка API", "NEVYGRV1C":"1}
</code>
ответ
<code>
OK
</code>

[[rest_adr|Продолжение - работа со списками и записями адресов клиентов]]

[[rest_s|Работа со справочниками через REST API]]
Водяной

Инструменты пользователя

Инструменты сайта

Инструменты страницы
