Об’єкт User та пов'язані з ним об'єкти Identificator, Account, Company, Employee

В даному об'єкті передається інформація про користувача.

JSON приклад

{
        "blockedServices": [],
        "role": 0,
        "roleAccess": 0,
        "accountRole": 4,
        "access": {},
        "identificators": [],
        "filters": [],
        "id": 77016,
        "accountId": 40692,
        "login": "FelexSpec1",
        "stringEmails": "docerrors@edi-n.com",
        "emails": [
                "docerrors@edi-n.com"
        ],
        "blocked": 0,
        "allowFTP": 1,
        "autoSending": true,
        "statusFile": 0,
        "isNotificationEnabled": 4,
        "isSatusFromOut": false,
        "isAdmin": false,
        "isSpecXML": false,
        "isCerts": 0,
        "XMLConv": 0,
        "account": {},
        "employee": {},
        "isStatusNotification": false,
        "isPasswordChange": false,
        "isSpecification": 1,
        "statusNotifyTypes": [],
        "otherInfo": {
                "needOriginalFilename": 0
        }
}

Опис параметрів об’єкта User

Параметр	Формат	Опис
blockedServices	List<String>	масив; список коротких назв заблокованих сервісів, наприклад: cert conv edi edi_uzd ftp offer price tender ttn user uzd
role	int	id ролі доступу користувача: 1 - Супер адміністратор; 2 - Адміністратор; 3 - Бухгалтер (Фінансист); 4 - Користувач.
roleAccess	int	id типу ролі: 0 - Все; 1 - Перегляд; 2 - Редагування; 3 - Підпис.
accountRole	int	id ролі в акаунті
access	Map<String, AccessStatus>	масив; доступ
identificators	List<Identificator>	масив; ідентифікатори
filters	List<UserFilterData>	фільтри
id	long	id користувача
accountId	long	id акаунта
login	String	логін користувача
stringEmails	String	список E-mail адрес в одному рядку
phone	String	телефон
emails	List<String>	масив; E-mail адреси
blocked	int	відмітка про блокування; число; 0 - немає, 1 - так
allowFTP	int	відмітка доступу до FTP; число; 0 - немає, 1 - так
autoSending	boolean	автовідправка документів
statusFile	int	створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання
isNotificationEnabled	int	повідомлення на E-mail 0 - Не отримувати 1 - Отримувати (EDI + Distribution) 2 - Отримувати (ЮЗД) 3 - Отримувати (Е-Специфікація) 4 - Отримувати (EDI + Distribution + Е-Специфікація)
isSatusFromOut	boolean
isAdmin	boolean	користувач є адміністратором
isSpecXML	boolean	включена конвертація файлів
isCerts	int	доступ до сервісу Е-Сертифікати; 0 - ні, 1 - так, 2 - так (Адміністратор)
XMLConv	int	XML-конвертор 0 - немає 1 - EANCOM \| .edi 2 - X12 \| .x12 3 - CSV \| .csv 4 - DBF (dBase_V) \| .dbf
account	Account	об’єкт; дані акаунта
companies	List<Company>	масив об’єктів; дані компаній
employee	Employee	об’єкт; дані співробітника
isStatusNotification	boolean	статус повідомлення
isPasswordChange	boolean	зміна паролю
isSpecification	int	доступ до сервісу Е-Специфікація; 0-ні, 1-так
statusNotifyTypes	List<Integer>	масив; типи статусів
otherInfo	UserOtherInfo	об’єкт; додаткове інфо

Опис параметрів об’єкта Identificator

Параметр	Формат	Опис
guid	String	GUID організації
taxNum	String(50)	Податковий ідентифікаційний номер
ndsNum	String(50)	№ свідоцтва ПДВ
manager	String(100)	ПІБ менеджера
accountant	String(100)	ПІБ бухгалтера
id	long	GLN ID
gln	String(13)	GLN організації
companyId	long	id акаунта
retailerId	long	id мережі (ритейлера)
isUzdAts	int	ЮЗД від АТС; 0-ні, 1-так
isFinCrypt	int	шифрування FINDOC; 0-ні, 1-так
countryId	int	ідентифікатор країни
isERNN	int	схема обробки DECLAR; 0 - відправка отримувачу тільки після успішної реєстрації в реєстрі, 1 - реєстрація після перевірки отримувачем, 3 - відправка отримувачу без реєстрації
name	String(100)	назва організації
nameEn	String	назва організації латиницею
companyType	String(5)	форма власності: jur - Юридична особа, fiz - Фізична особа
companyInn	String(50)	код ІПН компанії
companyKpp	String(50)	код ЄДРПОУ/КПП
companyOgrn	String(15)	Основний Державний Реєстраційний Номер
companyTaxDepartmentID	String	ідентифікатор відділення податкової інспекції
dirLastName	String(150)	прізвище директора
dirFirstName	String(150)	ім’я директора
director	String(100)	ПІБ директора
apartment	String(20)	квартира
zip	String(20)	поштовий індекс
katottg	String(20)	код КАТОТТГ
city	String(50)	місто
street	String(100)	назва вулиці
regionCode	String(3)	код регіону
bankName	String(100)	назва банку
bankMfo	String	МФО банку, код-реквізит банку
phone	String(50)	№ телефону
bankAccount	String(50)	розрахунковий рахунок банку
otherInfo	String	коментарі
email	String(255)	E-mail
metroCode	String(20)	код точки доставки
IBAN	String	IBAN (англ. International Bank Account Number)
district	String	назва району
dpiCReg	String	регіон/область податкової
dpiCRaj	String	район (по регіону) прив’язки до податкової
account	Account	id акаунту
isListex	boolean	підключений довідник Listex
isDeclarDateNumRequired	boolean	обов’язковість № і дати ПН в ТН (МЕТРО)
distribexUser	int	користувач сервісу; 1-Виробник; 2-Дистриб’ютор
isWithoutTax	boolean	неплатник ПДВ
additionalInfo	IdentificatorAdditionalInfo_	додаткова інформація
taxSource	int	Код ознаки джерела податкового номера 0 - відсутній 1 - Єдиний державний реєстр підприємств та організацій України (ЄДРПОУ); 2 - Державний реєстр фізичних осіб – платників податків (ДРФО); 3 - реєстраційний (обліковий) номер (для платників податків, які не включені до ЄДРПОУ); 4 - серія та номер паспорта (для фізичних осіб, які через релігійні переконання відмовляються від прийняття реєстраційного номера)
driverLicense	String	номер водійського посвідчення
isDriver	boolean	має роль Водій (робота з ТТН та коригуючими Актами)
isSignConfirm	int	gln підтверджений КЕП (0-ні; 1-так)
isSpecification	int	доступ до сервісу Е-Специфікація (0-ні; 1-так)
isCompany	int	атрибут; Основний GLN компанії (0-ні; 1-так)
parentId	long	значення Основного GLN компанії
parentIdentificator	Identificator	дані Основного GLN (за наявності)

Опис параметрів об’єкта Account

Параметр	Формат	Опис
accountId	long	ID акаунта
companyId	long	ID компанії
company	Company	об’єкт; дані про компанію
mfo	String	МФО банку
paymentAccount	String	розрахунковий рахунок
tariffId	int	ID тарифу
fullName	String	ПІП користувача
phone	String	телефон
email	String	Email
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	AccountInfo_	об’єкт; додаткова інформація про акаунт
adminAccount	AdminAccount_	об’єкт; данні по акаунту в Адмінці

Опис параметрів об’єкта Company

Параметр	Формат	Опис
id	long	id компанії; число
account	Account	об’єкт; дані акаунта
name	String	повне найменування організації або ПІБ індивідуального підприємця
ownership	String	форма власності; рядок 5 символів; jur - Юридична особа, fiz - Фізична особа
edrpou	String	код ЄДРПОУ/КПП; рядок 50 символів
inn	String	код ІПН; рядок 50 символів
mail	String	пошта
phone	String	№ телефону; рядок 50 символів
ndsNumber	String	№ свідоцтва ПДВ; рядок 50 символів
bankAccount	String	розрахунковий рахунок банку; рядок 50 символів
bankName	String	назва банку; рядок 100 символів
bankMfo	String	МФО банку, код-реквізит банку
bankAddress	String	адреса банку; рядок 150 символів
users	List<User>	масив об’єктів;

Опис параметрів об’єкта Employee

Параметр	Тип поля ¹	Формат	Опис
uuid	O/M	UUID	ідентифікатор співробітника (параметр обов’язковий для редагування/оновлення даних співробітника)
userId	O	long	id користувача
lastName	M	String	прізвище співробітника
firstName	M	String	ім’я співробітника
middleName	O	String	по батькові співробітника
ipn	O	long	код ІПН співробітника
email	M	String	email співробітника
tel	M	String	номер телефону співробітника
docNum	O	String	документ підстава
docDate	O	long	дата документа підстави у форматі UNIX TimeStamp
chatId	O	long	ідентифікатор чату (telegram помічник)
identifiers	O	Map<Integer, String>	додаткові дані; контакти
aliases	O	List<String>	масив аліасів (email) для сервісу Вільний

[1] - Під визначенням колонки Тип поля мається на увазі скорочене позначення:

M (mandatory) — обов’язкові до заповнення поля;
O (optional) — необов’язкові (опціональні) до заповнення поля.