Компанії

Дата створення 2026-05-05

Дата останньої зміни 2026-05-05

Отримання токена

Cтворення компанії

Метод дозволяє створити нову компанію в CRM IPTel.
Метод: POST

https://{API_ENDPOINT}:8443/ics3/rest/crm/company

Додаткові сутності

1. Тип партнера. Детальніше про отримання типів партнерів.
2 .Користувачі. Детальніше про.отримання користувачів.
3. Акаунти Viber. Детальніше про отримання акаунтів Viber.

Метод: POST

Body

Назва параметра	Доступні значення (тип)	Примітки
name	string	Назва компанії
address	string	Адреса компанії
email	string	Email компанії
phoneNumber	string	Номер телефону
website	string	Вебсайт компанії
telegramUsernames	string[]	Telegram нікнейми
viberAccounts	ViberAccountInfo[]	Список Viber акаунтів
responsible	SimpleUserDto	Відповідальний користувач
createdBy	SimpleUserDto	Користувач, який створив компанію
creationTime	string	Дата створення
modifiedTime	string	Дата модифікації
partnerType	PartnerType	Тип партнера
additionalFieldValues	AdditionalFieldValue[]	Додаткові поля компанії. Увага! Для коректної роботи слід передавати всі доступні поля.
externalId	string	Зовнішній ID компанії

Додаткові об’єкти

ViberAccountInfo

Назва параметра	Доступні значення (тип)	Примітки
viberAccountId	string	ID Viber акаунта
name	string	Назва акаунта
lastTimeMessageReceived	string	Дата останнього отриманого повідомлення

AdditionalFieldValue

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID значення
additionalField	SimpleIcsEntity	Додаткове поле
additionalForm	SimpleIcsEntity	Форма додаткового поля
value	string[]	Значення поля
entityType	"LEAD" \| "CONTACT" \| "COMPANY" \| "DEAL"	Тип сутності
entityId	number	ID сутності

SimpleUserDto

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID користувача
name	string	Ім’я користувача

PartnerType

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID користувача
partnerType	string	Тип партнера

Приклад запиту

curl -X POST \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/company" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {TOKEN}" \
  -d '{"name":"New company","address":"","email":"","responsible":null,"website":"","partnerType":{"id":1,"partnerType":"Клієнт"},"phoneNumber":"","telegramUsernames":[""],"viberAccounts":[],"externalId":"","id":0,"createdBy":{"id":1},"creationTime":"05-05-2026 09:46","modifiedTime":"05-05-2026 09:46","additionalFieldValues":[],"tags":[]}'

Створення компанії з ліда

Метод дозволяє створити компанію на основі існуючого ліда та (опційно) перенести пов’язані сутності.

Body

Назва параметра	Доступні значення (тип)	Примітки
company	CrmCompany	Дані нової компанії
leadId	number	ID ліда, з якого створюється компанія
deals	CrmDeal[]	Список угод для перенесення (опційно)
transferAttachedEntities	boolean	Чи переносити пов’язані сутності з ліда (дзвінки, коментарі, email і т. д.)

Додаткові об’єкти

CrmDeal

Назва параметра	Тип	Примітки
budget	number	Бюджет угоди
company	SimpleIcsEntity	Компанія
contact	SimpleIcsEntity	Контакт
createdBy	SimpleUserDto	Користувач, який створив угоду
creationDate	string	Дата створення
decimalPlacesNumber	number	Кількість десяткових знаків
id	number	ID угоди
isDeleted	boolean	Чи видалена угода
isProposal	boolean	Чи є пропозицією
lead	SimpleIcsEntity	Пов’язаний лід
modifiedDate	string	Дата оновлення
name	string	Назва угоди
orders	DealOrder[]	Замовлення
phase	IcsPhase	Фаза угоди
responsible	User	Відповідальний користувач
currency	Currency	Валюта
additionalFieldValues	AdditionalFieldValue[]	Додаткові поля угоди

IcsPhase

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID фази
name	string	Назва фази
pipelineId	number	ID воронки

SimpleUserDto, SimpleIcsEntity

Назва параметра	Доступні значення (тип)	Примітки
id	number	ID користувача
name	string	Ім’я користувача

DealOrder

Назва параметра	Тип	Примітки
good	Good	Товар
goodPriceWithDiscount	number	Ціна товару зі знижкою
amount	number	Кількість
dealId	number	ID угоди
finalPrice	number	Фінальна ціна
id	number	ID позиції
appliedDiscountPercentage	number	Відсоток знижки
appliedDiscountSum	number	Сума знижки
period	string	Період
priority	number	Пріоритет
description	string	Опис
discounts	Discount[]	Список знижок
temporaryIdForNewElement	string	Тимчасовий ID (для нових елементів)

Discount

Назва параметра	Тип	Примітки
id	number	ID знижки
isPositive	boolean	Позитивна/негативна знижка
maxPercentOff	number	Максимальний відсоток знижки
name	string	Назва знижки
type	"CONSTANT" \| "FLOATING"	Тип знижки
user	User	Користувач
userGroup	UserGroup	Група користувачів
currentPercentOff	number	Поточний відсоток знижки

Метод: POST
URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/company/create-from-lead

Приклад запиту

curl -X POST \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/company/create-from-lead" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {TOKEN}" \
  -d '{"company":{"id":0,"name":"New lead","firstName":"","lastName":"","companyName":"","position":"","responsible":null,"phoneNumbers":[""],"emails":[""],"telegramUsernames":[""],"viberAccounts":[],"created":"05-05-2026 10:06","modified":"05-05-2026 10:06","phase":{"id":17,"name":"Новый","pipelineId":5,"color":"0000ff","phaseType":null,"priority":null,"phaseRestriction":null},"source":null,"isConverted":false,"externalId":"","isAdditionalFormsValid":true,"dealsCount":null,"additionalFieldValues":[{"id":55550,"additionalField":{"id":35,"name":"Тест"},"additionalForm":{"id":11,"name":"Номер"},"value":["2"],"entityType":"COMPANY","entityId":0},{"id":55552,"additionalField":{"id":18,"name":"Область"},"additionalForm":{"id":8,"name":"Селект"},"value":[""],"entityType":"COMPANY","entityId":0},{"id":55551,"additionalField":{"id":17,"name":"Місто"},"additionalForm":{"id":8,"name":"Селект"},"value":[""],"entityType":"COMPANY","entityId":0},{"id":55553,"additionalField":{"id":34,"name":"Мкльтиселект"},"additionalForm":{"id":8,"name":"Селект"},"value":[""],"entityType":"COMPANY","entityId":0},{"id":55554,"additionalField":{"id":38,"name":"Третій"},"additionalForm":{"id":8,"name":"Селект"},"value":[""],"entityType":"COMPANY","entityId":0},{"id":55557,"additionalField":{"id":37,"name":"123"},"additionalForm":{"id":10,"name":"Дата"},"value":[""],"entityType":"COMPANY","entityId":0},{"id":55556,"additionalField":{"id":33,"name":"Порожня дата"},"additionalForm":{"id":10,"name":"Дата"},"value":[""],"entityType":"COMPANY","entityId":0},{"id":55555,"additionalField":{"id":31,"name":"Сьогодні"},"additionalForm":{"id":10,"name":"Дата"},"value":["05-05-2026 10:05"],"entityType":"COMPANY","entityId":0},{"id":55558,"additionalField":{"id":13,"name":"Відкрити у ClinicCards"},"additionalForm":{"id":3,"name":"Кнопка"},"value":["https://cliniccards.com/cabinet#patients/edit/{{ics_lead-external-id}}"],"entityType":"COMPANY","entityId":0},{"id":55560,"additionalField":{"id":36,"name":"Якийсь текст"},"additionalForm":{"id":3,"name":"Кнопка"},"value":["123"],"entityType":"COMPANY","entityId":0},{"id":55559,"additionalField":{"id":21,"name":"test2231"},"additionalForm":{"id":3,"name":"Кнопка"},"value":["{{ics_contact-first-name}}"],"entityType":"COMPANY","entityId":0}],"hasTags":false,"hasTasks":false,"tags":[],"creationTime":"05-05-2026 10:06","modifiedTime":"05-05-2026 10:06","phoneNumber":"","email":"","createdBy":{"id":1},"address":"","partnerType":null,"website":""},"leadId":1742,"deals":[],"transferAttachedEntities":true}'

Модифікація компанії

Метод дозволяє оновити існуючу компанію.
Метод: PUT

URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/company/{id}

Приклад запиту

curl -X PUT \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/company/{id}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {TOKEN}" \
  -d '{"id":36,"name":"Updated company","responsible":null,"phoneNumber":"","email":"","telegramUsernames":[""],"viberAccounts":[],"website":"","createdBy":{"id":1,"username":null,"workPhone":null,"name":null},"partnerType":{"id":1,"partnerType":"Клієнт"},"address":"","creationTime":"05-05-2026 09:46","modifiedTime":"05-05-2026 09:49","externalId":"","isAdditionalFormsValid":true,"additionalFieldValues":[],"hasTags":null,"tags":[]}'

Отримання всіх компаній

Метод дозволяє отримати список всіх компаній.
Метод: GET
URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/company

Приклад запиту

curl -X GET \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/company" \
  -H "Authorization: Bearer {TOKEN}"

Фільтрування компаній

Метод дозволяє отримати список компаній з можливістю фільтрації, сортування та пагінації.

Метод: GET

Query

Назва параметра	Доступні значення (тип)	Примітки
ids	number[]	Список ID компаній
address	string	Адреса компанії
createdById	number	ID користувача, який створив компанію
email	string	Email компанії
fromDateTimeCreated	string	Дата створення від
toDateTimeCreated	string	Дата створення до
fromDateTimeModified	string	Дата модифікації від
toDateTimeModified	string	Дата модифікації до
name	string	Назва компанії
partnerTypeId	number	Тип партнера
phoneNumber	string	Номер телефону
responsibleId	number	ID відповідального користувача
website	string	Вебсайт компанії
telegramUsername	string	Telegram нік користувача
additionalFields	AdditionalFieldFilterData[]	Додаткові поля з оператором та значенням. Приклад: &af12<100 – фільтрація по додатковому полю з id=2, при значення більшому 100
additionalFieldsId	string[]	ID додаткових полів
tags	number[]	Список ID тегів
externalId	string	Зовнішній ID компанії
pageSize	number	Максимальна кількість записів
start	number	Початковий індекс для пагінації
sortByField	string	Поле для сортування
sortingOrder	"ASC" \| "DESC"	Порядок сортування

URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/company/filter?{query_params}

Приклад запиту

curl -X GET \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/company/filter?pageSize=10&start=0&name=updated" \
  -H "Authorization: Bearer {TOKEN}"

Отримання компанії за ID

Метод дозволяє отримати детальну інформацію про компанію за її ID.

Метод: GET
URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/company/{id}

Приклад запиту

curl -X GET \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/company/{id}" \
  -H "Authorization: Bearer {TOKEN}"

Видалення компанії по ID

Метод дозволяє видалити компанію за ID.

Метод: DELETE
URL

https://{API_ENDPOINT}:8443/ics3/rest/crm/company/{id}

Приклад запиту

curl -X DELETE \
  "https://{API_ENDPOINT}:8443/ics3/rest/crm/company/{id}" \
  -H "Authorization: Bearer {TOKEN}"

Навігація

Отримання токена
Cтворення компанії
Додаткові сутності
Body
Приклад запиту
Створення компанії з ліда
Приклад запиту
Модифікація компанії
Приклад запиту
Отримання всіх компаній
Приклад запиту
Фільтрування компаній
Приклад запиту
Отримання компанії за ID
Приклад запиту
Видалення компанії по ID
Приклад запиту