Это старая версия документа!
В запросах чтения можно использовать отборы:
offset (int) - сдвиг
limit (int)- кол-во извлекаемых записей
(Примечание: записи выбираются в порядке внутреннего кода)
created_gte - Только созданные >= этой даты
created_lte - Только созданные ⇐ этой даты
updated_gte - Только измененные >= этой даты
updated_lte - Только измененные ⇐ этой даты
Клиенты и адреса
- получить список клиентов
Пример запроса (записи не более 2 клиентов, созданных или обновленных после 1 января 2020 г.):
GET http://127.0.0.1:10400/api/clients?updated_gte="01.01.2020"&limit=2
Ответ:
{
"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
}
Поля:
ID - Уникальный идентификатор (код записи)
NAIMENOVANIE - Имя/Наименование клиента
TELEFON - Номер телефона (общий по клиенту)
DOP_SC - Дополнительные сведения (комментарий по клиенту)
EMAIL - Электронная почта
DSZD - Дата создания
DATAIZM - Дата последнего обновления
DISP - ответственный за клиента (код из справочника сотрудников)
Состав полей может отличаться от приведенного, пустые значения не передаются.
Получить реквизиты контрагента по его коду
GET /clients/:id Пример
GET http://127.0.0.1:10400/api/clients/1000000000048
Ответ
{ "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"}}
Получить задолженность контрагента
GET /clients/:id/balance Пример
GET http://127.0.0.1:10400/api/clients/1000000000048/balance
Ответ
{"result": 100.00}
Возвращаемое значение - ДОЛГ клиента на утро текущего дня (без учета отгрузок и платежей, проведенных текущим днем). Отрицательное значение возвращается, если есть предоплата.
Создать контрагента и основной адрес
POST http://127.0.0.1:10400/api/clients
тело запроса (JSON):
{"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!!!"
}
ответ
{"result": 1000000000092","adr":1000000000084}
Здесь 1000000000092 - код нового контрагента, 1000000000084 - код его основного адреса
Создать дополнительный адрес
POST http://127.0.0.1:10400/api/addresses/
тело запроса (JSON):
{"kontragent":1000000000061,
"telefon":"7123456789 Маша, 79181231231 Ира",
"ulica":1000000000042,
"dom":"55",
"kv":"2",
"etoof":1,
"commvod":"ПРОПУСК!!!",
"commdisp":"Если не отвечают, везти без звонка"
}
Примечание: kontragent - ссылка на клиента, которому следует добавить адрес
ответ
{"result": 1000000000085}
Здесь 1000000000085 - код нового адреса.
Изменить реквизиты клиента
PATCH /clients/:id Пример
http://127.0.0.1:10400/api/clients/1000000000060
Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы).
{"naimenovanie":"Торговый дом 'Сидоров и сыновья'", "dop_sv":"Проверка API", "NEVYGRV1C":"1}
ответ
OK
Изменить реквизиты адреса
PATCH /adresses/:id Пример
http://127.0.0.1:10400/api/addresses/1000000000086
Тело запроса (JSON, содержащий измененные поля; служебные поля будут проигнорированы).
{"telefon":"7123456799 Маша, 79181231222 Ира",
"ulica":1000000000033,"dom":"1","kv":"2","etoof":1,
"commdisp":"Пропуск накануне!"}
ответ
OK
Получить запись адреса по коду
GET /addresses/:id Пример
GET http://127.0.0.1:10400/api/addresses/1000000000086
ответ
{
"result": {
"ID": "1000000000086",
"OSNTABL_ID": "1000000000055",
"NAIMENOVANIE": "12-я линия ул,1, оф.2",
"GOROD": "1000000000004",
"ULICA": "1000000000033",
"DOM": "1",
"KV": "2",
"ET": "0",
"TELEFON": "7123456799 Маша",
"COMMENT": "Пропуск накануне!",
"DOP_SV": "Если не отвечают, внутренний 2-15 ",
"DSZD": "23.03.2020 11:13:17",
"DATAIZM": "23.03.2020 16:00:58"
}
}
Вспомогательные справочники
Получить список сотрудников
GET /employees
Пример: список сотрудников, отредактированных после 8 утра 23.03.2020:
GET http://127.0.0.1:10400/api/employees?updated_gte="23.03.2020 08:00:00"
ответ
{
"result": [{
"ID": "1000000000005",
"NAIMENOVANIE": "Зарулин",
"IMJA": "Водитель",
"DOLJNOST": "1000000000005",
"VIDDOLJN": "0",
"DSZD": "24.03.2019 8:59:35",
"DATAIZM": "23.03.2020 16:04:06"}
],
"total": 1
}
DOLJNOST- код в справочнике должностей
VIDDOLJN - вид должности, если заполнен в справочнике должностей (перечисление: 0 -водитель, 1-экспедитор, 2- диспетчер, 3- помощник экспедитора, 4 -персональный менеджер, 5- Мастер по ремонту)
Список записей справочника "оборотная тара"
GET /packings Запрос:
http://127.0.0.1:10400/api/packings
ответ
{"result": [{ "ID": "1000000000001",
"NAIMENOVANIE": "Бутыль 19л",
"DSZD": "23.03.2019 21:39:13",
"DATAIZM": "25.01.2020 7:19:54"
}],
"total": 1}
Список автомобилей
GET /cars
Список смен
GET /shift-types
http://127.0.0.1:10400/api/shift-types
ответ
{
"result": [
{
"ID": "1000000000002",
"NAIMENOVANIE": "08-13",
"VREM_NACH": "8.0",
"VREM_OKON": "13.0",
"DSZD": "23.09.2019 13:03:45",
"DATAIZM": "03.03.2020 8:10:50"
},
{
"ID": "1000000000003",
"NAIMENOVANIE": "14-20",
"VREM_NACH": "14.0",
"VREM_OKON": "20.0",
"DSZD": "23.09.2019 13:03:47",
"DATAIZM": "03.03.2020 8:10:54"
}
],
"total": 2
}
Список товаров
GET /products Пример - получить, из числа созданных с начала года, один товар, пропустив первые 3.
http://127.0.0.1:10400/api/products?created_gte="01.01.2020"&limit=1&offset=3
Ответ
{
"result": [{
"ID": "1000000000004",
"NAIMENOVANIE": "Вода Алга",
"KRNAIM": "АЛ19",
"VES": "19",
"EDINICA": "1000000000001",
"TARA": "1000000000001",
"OKEI": "796",
"DSZD": "26.01.2020 16:02:24",
"NDS": "20",
"DATAIZM": "12.03.2020 18:46:00"
}
],
"offset": 3, "limit": 1, "total": 1
}
Здесь KRNAIM - наименование для ведомости или мобильного приложения,
EDINICA - код из справочника единиц измерения
OKEI - код единицы по общероссийскому классификатору
TARA - код из справочника «оборотная тара», для товаров в одноразовой упаковке отсутствует.
NDS - процент НДС, если указан в справочнике. Если не задан, применяется основная ставка фирмы. Для фирм, работающих без НДС, значения не имеет (при отгрузке всегда применяется ставка «Без НДС»).
Инструменты страницы
