Отримання списку контрагентів

Для роботи з цим методом користувач повинен бути авторизованим .

Метод запиту

HTTP GET

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edin.ua/bdoc/partners

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Опціональні url-параметри (фільтр)

search_pattern - код ЕДРПОУ або назва компанії

limit - ліміт вибірки (за замовчанням=20)

offset - зміщення відносно верхньої межі вибірки (за замовчанням=0)

is_registered - відмітка про те, що контрагент зареєстрований на платформі DOCflow; 1 - так, 0 - ні

JSON-параметри в тілі HTTP запиту/відповіді

REQUEST

В цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).

RESPONSE

Опис json-параметрів відповіді метода API (об’єкт Partner)

Таблиця 3 - Опис параметрів об’єкта Partner

Параметр

Формат

Опис

Об’єкт Partner

partnerId

long

id контрагента-партнера

accountId

long

id аккаунта

code

String

код ЕДРПОУ

name

String

назва компанїї

contactPerson

String

ПІБ контактної особи

contactEmail

String

Email контактної особи

contactPhone

String

контактный телефон

comment

String

коментар

invitationDate

long

дата / час запрошення

status

int

статус запрошення

contractStatus

int

статус сценарію документообігу (відмітка про те, що контрагент зареєстрований на платформі DOCflow); 1 - так, 0 - немає

companyId

long

id компанії


Приклади

При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)


Приклад тіла відповіді (json):

[
  {
    "partnerId": 762,
    "accountId": 8,
    "code": "3260408077",
    "name": "Arsen",
    "contactPerson": "Arsen contact-person",
    "contactEmail": "[email protected]",
    "contactPhone": "123244",
    "comment": "fdf",
    "invitationDate": 1566223863,
    "status": 2,
    "contractStatus": 0,
    "companyId": 0
  },
  {
    "partnerId": 766,
    "accountId": 8,
    "code": "12345678",
    "name": "Физычна особа",
    "contactEmail": "[email protected]",
    "invitationDate": 1566222958,
    "status": 2,
    "contractStatus": 1,
    "companyId": 6
  },
]