Завантажити список контрагентів відправників / одержувачів / третя особа

Метод «getCounterparties», працює в моделі «Counterparty», цей метод завантажує список контрагентів відправників, отримувачі та третіх осіб.

Якщо в методі більше ніж 100 контрагентів відправників або отримувачів, необхідно використовувати параметр «Page».

Якщо в запит додати параметр «FindByString» (пошук по рядкам) та у властивостях вказати назву контрагента (Талісман), який необхідно знайти, то отримаємо запит за допомогою якого у довіднику знайдеться необхідний контрагент.

Приклад: "methodProperties": {

"FindByString": "Талісман",

"Page": "1"

}

Копію довідника необхідно зберігати на сторні клієнта та підтримувати його в актуальному стані.

Рекомендовано проводити оновлення довідників раз на день.

Текст запиту
Параметр Тип Опис
CounterpartyProperty* string[36] Вид контрагента Sender/Recipient/ThirdPerson
Page string[36] Сторінка з інформацією для відображення (не більше 100 записів на одній сторінці)
* Позначення обов’язкового параметру
                        
 
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "Counterparty",
   "calledMethod": "getCounterparties",
   "methodProperties": {"CounterpartyProperty" : "Sender","Page" : "1"   }
}

                                
                                  




                                

Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.

Тіло відповіді на запит
Параметр Тип Опис
Description string[50] Опис українською мовою
Ref string[36] Ідентифікатор
City string[36] Місто контрагента
Counterparty string[36] Контрагент
FirstName string[36] Ім'я
LastName string[36] Прізвище
MiddleName string[36] По-батькові
OwnershipFormRef string[36] Ідентифікатор форми власності
OwnershipFormDescription string[36] Опис форми власності
EDRPOU string[36] Код ЄДРПОУ
CounterpartyType string[36] Тип контрагенту
                                  
{
  "success": true,
  "data": [{"Description" : "Талісман ТОВ","Ref" : "00000000-0000-0000-0000-000000000000","City" : "00000000-0000-0000-0000-000000000000","Counterparty" : "null","FirstName" : "Іван","LastName" : "Іванов","MiddleName" : "Іванович","OwnershipFormRef" : "00000000-0000-0000-0000-000000000000","OwnershipFormDescription" : "ТОВ","EDRPOU" : "37193071","CounterpartyType" : "Organization"  }],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}