Справочники — Контрагенты
Метод для создания или обновления контрагентов в Цифре из 1С.
Для создания или обновления контрагентов в Цифре необходимо отправить запрос на метод API, передав массив контрагентов в поле Data.
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
SecretKey |
string | Да | Секретный ключ |
Data |
array | Да | Массив контрагентов для создания/обновления |
Логика работы
- Данные передаются в массиве
Data - Если контрагент с переданным
Guidуже существует в системе — он будет обновлён - Если контрагента с таким
Guidнет — будет создан новый
Структура Data[]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
Guid |
string | Да | Идентификатор контрагента в 1C |
Name |
string | Да | Полное наименование компании |
Inn |
string | Нет | ИНН компании |
ShortName |
string | Нет | Краткое наименование |
CompanyType |
string | Нет | seller (организация) или client (контрагент, по умолчанию) |
LegalAddress |
string | Нет | Юридический адрес компании |
FactAddress |
string | Нет | Фактический адрес компании |
Address
|
Нет | Массив адресов | |
Managers
|
Нет | Массив контактных лиц |
Примечания
- Если контрагент с указанным
Guidуже существует, он будет обновлён - Компании с названиями, содержащими служебные значения ("ручной", "(не выбран)", "тест", "физ.лицо"), не будут созданы
- Телефон менеджера должен быть в формате 79998887766 (с 7, без +, без пробелов)
CompanyTypeпо умолчанию:client- Менеджеры без полей
NameилиPhoneбудут пропущены - Адреса без поля
Addressбудут пропущены - При создании компании обновляются связанные задачи (createOrder, createApplication)
- Не отправляйте за раз более 2000 компаний или более 1 МБ данных
Пример запроса
1С → Цифра
{
"SecretKey": "2akgzOCYsAxLwpNl",
"Data": [
{
"Guid": "22db4291-154f-11ec-973e-244bfecb4e0a",
"Inn": "7604377806",
"Name": "ООО ПРОМТЕХМОНТАЖ",
"ShortName": "ПРОМТЕХМОНТАЖ",
"CompanyType": "client",
"Type": "Юридическое лицо",
"Address": [
{
"Address": "г. Москва, ул. Ленина, д. 10",
"Name": "Офис",
"Latitude": "55.751244",
"Longitude": "37.618423"
}
],
"Managers": [
{
"Name": "Иванов Иван Иванович",
"Phone": "79998887766"
}
]
}
]
}
Коды ответов
| Код | Описание |
|---|---|
| 201 | Успешное создание. Все данные обработаны без ошибок (success: true) |
| 207 | Частичный успех. Часть данных обработана, но есть ошибки (success: true) |
| 401 | Ошибка ключа. Секретный ключ не найден (success: false) |
| 422 | Ошибка валидации. Data должен быть массивом (success: false) |
| 500 | Ошибка сервера. Внутренняя ошибка обработки (success: false) |
Структура ответа
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Успешность операции |
message |
string | Сообщение об успешных операциях |
data_id |
integer | ID записи в логе |
errors |
array | Массив ошибок (только при наличии ошибок) |
Примеры ответов
{
"success": true,
"message": "Создано компаний: 1. Обновлено компаний: 2. Создано представителей: 1. Обновлено представителей: 1. Создано адресов: 2. Обновлено адресов: 1",
"data_id": 123
}
{
"success": true,
"message": "Создано компаний: 1. Обновлено компаний: 1. Создано представителей: 1. Обновлено адресов: 2",
"data_id": 123,
"errors": [
"Компаний без GUID: 1",
"Компаний без названия: 2",
"Не удалось создать компанию (имя в стоп-листе: "ручной", "тест", "(не выбран)", "физ.лицо"): 1"
]
}
{
"success": false,
"message": "Секретный ключ не найден",
"data_id": null
}
{
"success": false,
"message": "Неверный тип данных",
"data_id": 123
}
{
"success": false,
"message": "Произошла ошибка: подробное описание ошибки",
"data_id": 123
}