Создание контрагентов
Метод для создания или обновления контрагентов в Цифре из 1С.
Запрос
POST /api/company/create
Параметры запроса
| Параметр |
Тип |
Обязательный |
Описание |
SecretKey |
string |
Да |
Секретный ключ |
Data |
array |
Да |
Массив контрагентов для создания/обновления
Структура Data[]
|
Структура Data[]
| Поле |
Тип |
Обязательное |
Описание |
Guid |
string |
Да |
Идентификатор в 1C |
Name |
string |
Да |
Полное наименование компании |
Inn |
string |
Нет |
ИНН компании |
ShortName |
string |
Нет |
Краткое наименование |
CompanyType |
string |
Нет |
seller (организация) или client (контрагент, по умолчанию)
|
LegalAddress |
string |
Нет |
Юридический адрес компании |
FactAddress |
string |
Нет |
Фактический адрес компании |
Address |
array |
Нет |
Массив адресов
Структура Address[]
|
Managers |
array |
Нет |
Массив контактных лиц
Структура Managers[]
|
Структура Address[]
| Поле |
Тип |
Обязательное |
Описание |
Address |
string |
Да |
Адрес |
Name |
string |
Нет |
Название (например, "Офис", "Склад") |
Latitude |
string |
Нет |
Широта |
Longitude |
string |
Нет |
Долгота |
Структура Managers[]
| Поле |
Тип |
Обязательное |
Описание |
Name |
string |
Да |
ФИО контактного лица |
Phone |
string |
Да |
Телефон, с 7, без "+", без пробелов (например: 79998887766) |
Пример запроса
{
"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"
}
]
}
]
}
Ответ
Коды ответов
| Код |
Описание |
200 |
Частичный успех. Часть данных обработана, но есть ошибки (success: true) |
201 |
Успешное создание. Все данные обработаны без ошибок (success: true) |
401 |
Ошибка ключа. Секретный ключ не найден (success: false) |
422 |
Ошибка валидации. Data должен быть массивом (success: false) |
500 |
Ошибка сервера. Внутренняя ошибка обработки (success: false) |
Структура ответа
| Поле |
Тип |
Описание |
success |
boolean |
Успешность операции |
message |
string |
Сообщение об успешных операциях |
data_id |
integer |
ID записи в логе |
errors |
array |
Массив ошибок (только при наличии ошибок) |
Успешный ответ (201)
{
"success": true,
"message": "Создано компаний: 1",
"data_id": 123
}
Частичный успех с ошибками (207)
{
"success": true,
"message": "Создано компаний: 1",
"data_id": 123,
"errors": [
"Компаний без GUID: 1",
"Компаний без названия: 2"
]
}
Ошибка ключа (401)
{
"success": false,
"message": "Секретный ключ не найден",
"data_id": null
}
Ошибка валидации данных (422)
{
"success": false,
"message": "Неверный тип данных",
"data_id": 123
}
Ошибка сервера (500)
{
"success": false,
"message": "Произошла ошибка: подробное описание ошибки",
"data_id": 123
}
Примечания
- Если контрагент с указанным Guid уже существует, он будет обновлен
- Компании с названиями, содержащими служебные значения ("ручной", "(не выбран)", "тест", "физ.лицо"), не будут созданы
- Телефон менеджера должен быть в формате 79998887766 (с 7, без +, без пробелов)
CompanyType по умолчанию: client.
- Менеджеры без полей
Name или Phone будут пропущены
- Адреса без поля
Address будут пропущены
- При создании компании обновляются связанные задачи (createOrder, createApplication)
- Не отправляйте за раз более 2000 компаний или более 1 МБ данных
См. также