Об’єкт User
В даному об'єкті передається інформація про користувача.
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
}
}JSON приклад для передачі данихабо кількох користувачів
.
[
{
"blockedServices": [],
"role": 2,
"roleAccess": 0,
"accountRole": 127,
"access": {},
"identificators": [],
"filters": [],
"id": 90688,
"accountId": 40692,
"login": "g1@gmail.com",
"stringEmails": "g1@gmail.com",
"phone": "380992369658",
"emails": [
"g1@gmail.com"
],
"blocked": 0,
"allowFTP": 0,
"autoSending": false,
"statusFile": 0,
"isNotificationEnabled": 1,
"isSatusFromOut": false,
"isAdmin": true,
"isSpecXML": false,
"isCerts": 2,
"XMLConv": 0,
"account": {
"id": 40692,
"name": "\"Тестова мережа - EDIN\"",
"ownership": "ТОВ",
"inn": "#",
"kpp": "34554363",
"mail": "kozlenkoy@edi-n.com",
"identificators": [],
"phone": "0443590112",
"ndsNumber": "#",
"users": [],
"billingMail": "kozlenkoy@edi-n.com",
"bankName": "#",
"bankAccount": "#",
"bankMfo": "#",
"bankAddress": "#",
"isOffert": false,
"country": "UA",
"address": "м. Київ, вул. Михайла Донця, буд.6",
"legalAddress": "м. Київ, вул. Михайла Донця, буд.6",
"factAddress": "м. Київ, вул. Михайла Донця, буд.6",
"directorName": "Франко І.Я.",
"tariffVersion": 1,
"directorPosition": "Директор",
"registrationDate": "2020-08-17 00:00:00",
"allowUnsignedComdoc": 0,
"allowUnsignedCondra": 0,
"platform": "FELEX",
"autoProlongation": true,
"docBasisForNTM": 0,
"isSignConfirm": 0,
"sessionsTTL": 3600,
"companies": []
},
"employee": {
"uuid": "3492a46f-998c-4aeb-990c-0293a8d59067",
"userId": 90688,
"lastName": "Прізвище",
"firstName": "Ім'я",
"email": "g1@gmail.com",
"tel": "380992369658",
"docDate": 0,
"identifiers": {},
"aliases": []
},
"isStatusNotification": false,
"isPasswordChange": false,
"isSpecification": 0,
"statusNotifyTypes": []
}
]
Опис параметрів об’єкта User
|
Параметр |
Формат |
Опис |
|---|---|---|
|
blockedServices |
List<String> |
масив; список коротких назв заблокованих сервісів, наприклад:
|
|
role |
int |
id ролі доступу користувача:
|
|
roleAccess |
int |
id типу ролі:
|
|
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
|
|
isSatusFromOut |
boolean |
|
|
isAdmin |
boolean |
користувач є адміністратором |
|
isSpecXML |
boolean |
включена конвертація файлів |
|
isCerts |
int |
доступ до сервісу Е-Сертифікати; 0 - ні, 1 - так, 2 - так (Адміністратор) |
|
XMLConv |
int |
XML-конвертор
|
|
account |
об’єкт; дані акаунта |
|
|
companies |
List<Company> |
масив об’єктів; дані компаній |
|
employee |
об’єкт; дані співробітника |
|
|
isStatusNotification |
boolean |
статус повідомлення |
|
isPasswordChange |
boolean |
зміна паролю |
|
isSpecification |
int |
доступ до сервісу Е-Специфікація; 0-ні, 1-так |
|
statusNotifyTypes |
List<Integer> |
масив; типи статусів |
|
otherInfo |
UserOtherInfo |
об’єкт; додаткове інфо |
Опис
JSON об’єктаприклад Identificator
Параметр
{
"blockedServices": [],
Формат
Опис
guid
String
GUID"login": організації
taxNum
String(50)
Податковий"autoSending": ідентифікаційнийtrue,
номер
ndsNum
String(50)
№0,
свідоцтва"XMLConv": ПДВ
manager
String(100)
ПІБ"statusNotifyTypes": менеджера
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;"needOriginalFilename": 0
-}
відправка}
отримувачу
тільки
JSON успішноїприклад реєстраціїдля впередачі реєстрі,даних 1кількох користувачів
[
{
"blockedServices": [],
"role": 2,
"roleAccess": 0,
"accountRole": 127,
"access": {},
"identificators": [],
"filters": [],
"id": 90688,
"accountId": 40692,
"login": "g1@gmail.com",
"stringEmails": "g1@gmail.com",
"phone": "380992369658",
"emails": [
"g1@gmail.com"
],
"blocked": 0,
"allowFTP": 0,
"autoSending": false,
"statusFile": 0,
"isNotificationEnabled": 1,
"isSatusFromOut": false,
"isAdmin": true,
"isSpecXML": false,
"isCerts": 2,
"XMLConv": 0,
"account": {
"id": 40692,
"name": "\"Тестова мережа - реєстраціяEDIN\"",
після"ownership": перевірки"ТОВ",
отримувачем,"inn": 3"#",
-"kpp": відправка"34554363",
отримувачу"mail": без"kozlenkoy@edi-n.com",
реєстрації"identificators": [],
"phone": "0443590112",
"ndsNumber": "#",
"users": [],
"billingMail": "kozlenkoy@edi-n.com",
"bankName": "#",
"bankAccount": "#",
"bankMfo": "#",
"bankAddress": "#",
"isOffert": false,
"country": "UA",
"address": "м. Київ, вул. Михайла Донця, буд.6",
"legalAddress": "м. Київ, вул. Михайла Донця, буд.6",
"factAddress": "м. Київ, вул. Михайла Донця, буд.6",
"directorName": "Франко І.Я.",
"tariffVersion": 1,
"directorPosition": "Директор",
"registrationDate": "2020-08-17 00:00:00",
"allowUnsignedComdoc": 0,
"allowUnsignedCondra": 0,
"platform": "FELEX",
"autoProlongation": true,
"docBasisForNTM": 0,
"isSignConfirm": 0,
"sessionsTTL": 3600,
"companies": []
},
"employee": {
"uuid": "3492a46f-998c-4aeb-990c-0293a8d59067",
"userId": 90688,
"lastName": "Прізвище",
"firstName": "Ім'я",
"email": "g1@gmail.com",
"tel": "380992369658",
"docDate": 0,
"identifiers": {},
"aliases": []
},
"isStatusNotification": false,
"isPasswordChange": false,
"isSpecification": 0,
"statusNotifyTypes": []
}
]
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
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
дані Основного GLN (за наявності)
Опис параметрів об’єкта Account
Параметр
Формат
Опис
accountId
long
ID акаунта
companyId
long
ID компанії
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
об’єкт; дані акаунта
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
Параметр
Тип поля 1
Формат
Опис
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) для сервісу Вільний
-
M (mandatory) — обов’язкові до заповнення поля;O (optional) — необов’язкові (опціональні) до заповнення поля.