Отримання інформації про організацію по Назві/ІПН/КПП/GLN¶
Для роботи з цим методом користувач повинен бути авторизованим .
Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального аккаунта.
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло HTTP запиту / відповіді в json форматі) |
URL запиту |
|
Параметри, що передаються в URL (разом з адресою методу) |
У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації Обов’язкові url-параметри: gln - рядок (13); номер GLN організації, яка пов’язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта query - рядок; назва/ІПН/КПП/GLN організації; «Над яким здійснюється дія» |
Підказка
Також можливо виконати запит у вигляді curl-рядка:
curl -X GET „https://edo-v2.edi-n.com/api/oas/identifiers?gln=9864065702429&query=EDS_1“ -b „SID=458a0d38-5b56-4b8e-8998-009a1edd31eb“
Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html
JSON-параметри в тілі HTTP запиту/відповіді
REQUEST
У цьому методі json-тіло запиту відсутнє (інші дані передавати не потрібно).
RESPONSE
Таблиця 1 - Опис json-параметрів, які можуть передаватися у відповідь на метод API
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Identificator |
||
guid |
String |
GUID організації |
taxNum |
String |
Податковий ідентифікаційний номер; рядок 50 символів |
ndsNum |
String |
№ свідоцтва ПДВ; рядок 50 символів |
manager |
String |
ПІБ менеджера; рядок 100 символів |
accountant |
String |
ПІБ бухгалтера; рядок 100 символів |
id |
long |
ID користувача |
gln |
String |
GLN організації, яка пов’язана з авторизованим користувачем?; рядок 13 символів |
companyId |
long |
id аккаунта; число |
retailerId |
long |
id мережі (ритейлера); число |
name |
String |
назва організації; рядок 100 символів |
companyType |
String |
форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа |
companyInn |
String |
код ІПН компанії; рядок 50 символів |
companyKpp |
String |
код ЄДРПОУ/КПП; рядок 50 символів |
companyOgrn |
String |
Основний Державний Реєстраційний Номер; рядок 15 символів |
companyTaxDepartmentID |
String |
ідентифікатор відділення податкової інспекції |
dirLastName |
String |
прізвище директора; рядок 150 символів |
dirFirstName |
String |
ім’я директора; рядок 150 символів |
apartment |
String |
квартира; рядок 20 символів |
zip |
String |
поштовий індекс; рядок 20 символів |
city |
String |
місто; рядок 50 символів |
street |
String |
назва вулиці; рядок 100 символів |
regionCode |
String |
код регіону; рядок 3 символу |
bankName |
String |
назва банку; рядок 100 символів |
bankMfo |
String |
МФО банку, код-реквізит банку |
phone |
String |
№ телефону; рядок 50 символів |
bankAccount |
String |
розрахунковий рахунок банку; рядок 50 символів |
otherInfo |
String |
коментарі |
String |
E-mail; рядок 255 символів |
|
metroCode |
String |
код точки доставки; рядок 20 символів |
Таблиця 2 - Опис параметрів об’єкта Account)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Account |
||
accountId |
long |
ID аккаунта |
companyId |
long |
ID компанії |
company |
об’єкт; дані про компанію |
|
mfo |
String |
МФО банку |
paymentAccount |
String |
розрахунковий рахунок |
tariffId |
int |
ID тарифу |
fullName |
String |
ПІП користувача |
phone |
String |
телефон |
String |
||
dirPosition |
String |
посада директора |
activityBase |
String |
підстава діяльності |
isIndivOffer |
int |
відмітка про наявність індивідуального договору; 0 - нет, 1 - есть |
adminAccountId |
long |
ID аккаунта в Адмінці |
addInfo |
String |
додаткова інформація |
whiteList |
List<String> |
масив; список білих ip адрес |
decryptType |
int |
тип розшифровки; 1 - WEB; 2 - Cryptex |
cryptexServer |
String |
адреса cryptex-сервера на стороні клієнта |
status |
int |
статус; 0 - заблокований; 1 - активний |
accountInfo |
об’єкт; додаткова інформація про аккаунт |
|
adminAccount |
об’єкт; данні по аккаунту в Адмінці |
Таблиця 3 - Опис параметрів об’єкта Company)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Company |
||
id |
long |
id компанії; число |
account |
об’єкт; дані аккаунта |
|
name |
String |
повне найменування організації або ПІБ індивідуального підприємця |
ownership |
String |
форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа |
edrpou |
String |
код ЄДРПОУ/КПП; рядок 50 символів |
inn |
String |
код ІПН; рядок 50 символів |
String |
пошта |
|
phone |
String |
№ телефону; рядок 50 символів |
ndsNumber |
String |
№ свідоцтва ПДВ; рядок 50 символів |
bankAccount |
String |
розрахунковий рахунок банку; рядок 50 символів |
bankName |
String |
назва банку; рядок 100 символів |
bankMfo |
String |
МФО банку, код-реквізит банку |
bankAddress |
String |
адреса банку; рядок 150 символів |
users |
List<User> |
масив об’єктів; |
Таблиця 4 - Опис параметрів об’єкта User)
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт User |
||
id |
long |
id користувача; число |
accountId |
long |
id аккаунта |
login |
String |
логін користувача; рядок 50 символів |
stringEmails |
String |
E-mail; рядок 255 символів |
emails |
List<String> |
масив адрес E-mail |
blocked |
int |
відмітка про блокування; число; 0 - немає, 1 - так |
allowFTP |
int |
відмітка доступу до FTP; число; 0 - немає, 1 - так |
autoSending |
boolean |
автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox) |
statusFile |
int |
створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання |
isAdmin |
boolean |
відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так |
Приклади
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді (json):
[
{
"guid": {},
"manager": "#",
"id": 133187,
"gln": "9864065702429",
"companyId": 29824,
"retailerId": 0,
"name": "EDS_1",
"companyType": "jur",
"companyInn": "1010101010",
"companyKpp": "90000031",
"zip": "112233",
"city": "г. Львов",
"street": "ул. Хмурится, 6",
"phone": "#",
"otherInfo": "[]",
"account": {
"platform": "EVO",
"id": 29824,
"name": "Test_EDS1",
"ownership": "#",
"inn": "1010101010",
"kpp": "100000001",
"mail": "[email protected]",
"phone": "12345678901",
"ndsNumber": "#",
"bankAccount": "#",
"bankName": "#",
"bankMfo": "#",
"bankAddress": "#",
"identificators": [],
"companies": [],
"users": []
}
}
]