API Контрагенты
Работа с данными Контрагента
- Создать Контрагента
- Создать контактное лицо Контрагента
- Создать Контрагента с типом (юридическое лицо) организация
- Создать Контрагента с типом третьего лица
- Загрузить список адресов Контрагентов
- Загрузить параметры Контрагента
- Загрузить список контактных лиц Контрагента
- Загрузить список Контрагентов отправителей/получателей/третье лицо
- Обновить данные Контрагента
- Обновить данные контактного лица Контрагента
- Удалить Контрагента получателя
- Удалить Контактное лицо Контрагента
Создать Контрагента с типом (юридическое лицо) или организацию
Метод «save», работает в модели «Counterparty», этот метод используется при создании Контрагента с типом (юридическое лицо) или организация. Название юр. лица подтягивается автоматически из справочника. Рекомендуется проводить обновление справочников раз в месяц.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | string | Свойства метода |
CounterpartyProperty | string[36] | Тип клиента получателя (Recipient) |
CounterpartyType * | string[36] | Тип контрагента |
EDRPOU * | string[36] | Код ЕГРПОУ |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Counterparty",
"calledMethod": "save",
"methodProperties": {
"CounterpartyType": "Organization",
"CounterpartyProperty": "Recipient",
"EDRPOU": "12345678"
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Counterparty</modelName>
<calledMethod>save</calledMethod>
<methodProperties>
<CityRef>8d5a980d-391c-11dd-90d9-001a92567626</CityRef>
<FirstName>ТурбоФірма</FirstName>
<MiddleName></MiddleName>
<LastName></LastName>
<Phone></Phone>
<Email></Email>
<CounterpartyType>Organization</CounterpartyType>
<CounterpartyProperty>Recipient</CounterpartyProperty>
<OwnershipForm>7f0f351d-2519-11df-be9a-000c291af1b3</OwnershipForm>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор |
Description | string[36] | Описание |
FirstName | string[36] | Название организации |
OwnershipForm | string[36] | Форма собственности |
OwnershipFormDescription | string[36] | Описание формы собственности |
EDRPOU | string[36] | Код ЕДРПОУ |
CounterpartyType | string[36] | Тип контрагента (организация) |
{
"success": true,
"data": [
{
"Ref": "b9cc2e6c-cb50-11e5-a70c-005056801333",
"Description": "ФірмаТурбо",
"FirstName": "ФірмаТурбо",
"MiddleName": "",
"LastName": "",
"Counterparty": "",
"OwnershipForm": "7f0f351d-2519-11df-be9a-000c291af1b3",
"OwnershipFormDescription": "ТОВ",
"EDRPOU": "",
"CounterpartyType": "Organization"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8" ?>
<root>
<success>true</success>
<data>
<item>
<Ref>da32de8d-cb53-11e5-a70c-005056801333</Ref>
<Description>ТурбоФірма</Description>
<FirstName>ТурбоФірма</FirstName>
<MiddleName/>
<LastName/>
<OwnershipForm>7f0f351d-2519-11df-be9a-000c291af1b3</OwnershipForm>
<OwnershipFormDescription>ТОВ</OwnershipFormDescription>
<CounterpartyType>Organization</CounterpartyType>
</item>
</data>
<errors/>
<warnings/>
<info/>
</root>