API Контрагенты
Работа с данными Контрагента
- Создать Контрагента
- Создать контактное лицо Контрагента
- Создать Контрагента с типом (юридическое лицо) организация
- Создать Контрагента с типом третьего лица
- Загрузить список адресов Контрагентов
- Загрузить параметры Контрагента
- Загрузить список контактных лиц Контрагента
- Загрузить список Контрагентов отправителей/получателей/третье лицо
- Обновить данные Контрагента
- Обновить данные контактного лица Контрагента
- Удалить Контрагента получателя
- Удалить Контактное лицо Контрагента
Загрузить список Контрагентов отправителей/получателей/третье лицо
Метод «getCounterparties», работает в модели «Counterparty», этот метод загружает список контрагентов отправителей, получателей или третьих лиц.
Если в методе более чем 100 контрагентов отправителей или получателей, необходимо использовать параметр «Page»
"methodProperties": {
"Page": "1"
}
Если в этот запрос добавить параметр «FindByString» (поиск по строкам) и в его свойствах прописать название контрагента (Талисман), который нужно найти, то получим запрос с помощью которого в справочнике находится нужный контрагент
"methodProperties": {
"FindByString": "Талісман"
}
Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в актуальном состоянии. Рекомендуется проводить обновление справочников раз в сутки.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
Форматы JSON, XML
Заголовки запросов
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | string | Свойства метода |
CounterpartyProperty | string[36] | Вид контрагента |
Sender/Recipient/ThirdPerson | string[36] | Отправитель, получатель или третье лицо |
Page | int[36] | Страница с информацией для отображения (не более 100 записей на одной странице) |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Counterparty",
"calledMethod": "getCounterparties",
"methodProperties": {
"CounterpartyProperty": "Sender",
"Page": "1"
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<root>
<modelName>Counterparty</modelName>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>getCounterparties</calledMethod>
<methodProperties>
<CounterpartyProperty>Sender</CounterpartyProperty>
<Page>1</Page>
</methodProperties>
<root>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Description | string[50] | Описание на украинском языке |
Ref | string[36] | Идентификатор |
City | string[36] | Город контрагента |
Counterparty | ||
FirstName | string[36] | Имя |
LastName | string[36] | Фамилия |
MiddleName | string[36] | Отчество |
OwnershipFormRef | string[36] | Идинтификатор формы собственности |
OwnershipFormDescription | string[36] | Описание формы собствености |
EDRPOU | int[36] | Код ОКПО |
CounterpartyType | string[36] | Тип контрагента |
{
"success": true,
"data": [
{
"Description": "Талісман ТОВ",
"Ref": "978e123a-70b4-11e4-ae68-0025909b4e33",
"City": "8d5a980d-391c-11dd-90d9-001a92567626",
"Counterparty": null,
"FirstName": "",
"LastName": "",
"MiddleName": "",
"OwnershipFormRef": "7f0f351d-2519-11df-be9a-000c291af1b3",
"OwnershipFormDescription": "ТОВ",
"EDRPOU": "37193071",
"CounterpartyType": "Organization"
},
{
"Description": "Марочний ТОВ ",
"Ref": "5953fb16-08d8-11e4-8958-0025909b4e33",
"City": "8d5a980d-391c-11dd-90d9-001a92567626",
"Counterparty": null,
"FirstName": "",
"LastName": "",
"MiddleName": "",
"OwnershipFormRef": "7f0f351d-2519-11df-be9a-000c291af1b3",
"OwnershipFormDescription": "ТОВ",
"EDRPOU": "37118680",
"CounterpartyType": "Organization"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Description>Баклажан ТОВ (Тестовий ЛК)</Description>
<Ref>6e9acced-d072-11e3-95eb-0050568046cd</Ref>
<City>8d5a980d-391c-11dd-90d9-001a92567626</City>
<Counterparty/>
<FirstName/>
<LastName/>
<MiddleName/>
<OwnershipFormRef>7f0f351d-2519-11df-be9a-
000c291af1b3</OwnershipFormRef>
<OwnershipFormDescription>ТОВ</OwnershipFormDescription>
<EDRPOU>99999999</EDRPOU>
<CounterpartyType>Organization</CounterpartyType>
</item>
<item>
<Description> Зірка Буковеля ТОВ</Description>
<Ref>c66d944a-b8f4-11e4-a77a-005056887b8d</Ref>
<City>8d5a980d-391c-11dd-90d9-001a92567626</City>
<Counterparty/>
<FirstName/>
<LastName/>
<MiddleName/>
<OwnershipFormRef/>
<OwnershipFormDescription/>
<EDRPOU/>
<CounterpartyType>Organization</CounterpartyType>
</item>
<item>
<Description> "Азов Петролеум ЛЛС" ТОВ</Description>
<Ref>c66d944b-b8f4-11e4-a77a-005056887b8d</Ref>
<City>8d5a980d-391c-11dd-90d9-001a92567626</City>
<Counterparty/>
<FirstName/>
<LastName/>
<MiddleName/>
<OwnershipFormRef/><OwnershipFormDescription/>
<EDRPOU/>
<CounterpartyType>Organization</CounterpartyType>
</item>
</data>
<errors/>
<warnings/>
<info/>
</root>