Завантажити список адрес Контрагентів
Метод «getCounterpartyAddresses», працює в моделі «Counterparty», цей метод завантажує список контрагентів відправників/отримувачів.
Необхідно зберігати копію довідника на стороні клієнта та підтримувати його в актуальному стані.
Рекомендовано проводити оновлення довідників раз на місяць.
Текст запиту
Параметр | Тип | Опис |
---|---|---|
Ref* | string[36] | Ідентифікатор (REF) контрагену |
CounterpartyProperty* | string[36] | Властивості контрагенту |
* Позначення обов’язкового параметру
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Counterparty",
"calledMethod": "getCounterpartyAddresses",
"methodProperties": {"Ref" : "00000000-0000-0000-0000-000000000000","CounterpartyProperty" : "Sender" }
}
Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.
Тіло відповіді на запит
Параметр | Тип | Опис |
Ref | string[36] | Ідентифікатор (REF) контрагену |
Description | string[50] | Опис адреси українською мовою |
{
"success": true,
"data": [{"Ref" : "00000000-0000-0000-0000-000000000000","Description" : "Хрещатик, 1" }],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}