Skip to main content

Об'єкт ESSCompany

Опис параметрів об’єкта
Поле Тип Опис
id number Внутрішній ідентифікатор компанії.
fullName string/null Повна назва українською.
shortName string/null Скорочена назва українською.
fullNameEN string/null Повна назва англійською.
shortNameEN string/null Скорочена назва англійською.
type enum Тип компанії, наприклад, COMPANY або SELF_EMPLOYED.
code string Код компанії/ФОП.
ipn string/null ІПН, якщо застосовується.
status enum Статус компанії. Частина write/action методів дозволена лише для ACTIVE компаній.
country string/null Країна.
state string/null Область/регіон.
locality string/null Населений пункт.
street string/null Адреса.
ceoName string/null ПІБ керівника.
agreemType enum/null Тип договору.
agreemNumber string/null Номер договору.
agreemDate number Дата договору, Unix timestamp у секундах.
ECDSAStatus або ecdsaStatus enum Готовність компанії до ECDSA залежно від EN-назв.
role enum/null Роль користувача в компанії, якщо company повернена в контексті співробітника.
employeeStatus enum/null Статус співробітника, якщо company повернена в контексті співробітника.
employeeEmail string/null Email співробітника в компанії, якщо доступний.

JSON приклад:

{
  "id": 123,
  "fullName": "ТОВ \"Тест\"",
  "shortName": "ТОВ \"Тест\"",
  "fullNameEN": "TEST LLC",
  "shortNameEN": "TEST LLC",
  "type": "COMPANY",
  "code": "25412361",
  "ipn": null,
  "status": "ACTIVE",
  "country": "UA",
  "state": "Київська",
  "locality": "Київ",
  "street": "вул. Тестова, 1",
  "ceoName": "Петренко Петро Петрович",
  "agreemType": "INDIVIDUAL",
  "agreemNumber": "123",
  "agreemDate": 1717200000,
  "role": null,
  "employeeStatus": null,
  "employeeEmail": null
}

 

Back to top