Документация Мегаплан API
1.0


Общая информация

Все ресурсы апи доступны по урлам с префиксом /api/v3/. Вы можете посмотреть RAML-описание по адресу /api/v3.

Все параметры запроса отправляются в виде JSON - и в теле и в заголовке.

Пример запроса товаров, с ограничением лимита 5

/api/v3/offer?{"limit":5}

Базовый ответ API:

{
    meta: {
        status: 200,
        errors: [ ],
        pagination: {
            count: 0,
            limit: 100
        }
    },
    data: [ ]
}

Ответ представляет собой два блока: meta и data.
Параметр data содержит полезные данные ответа. Параметр meta содержит дополнительную информацию:

Поле Описание
status Код ответа. Возможные варианта ответа приведены в таблице ниже
error Описание ошибок
pagination Информация о пагинации. Подробнее в разделе пагинации


Возможные коды ответа:

Код Ответ
200 Успешный ответ
422 Ошибка в запросе
403 Ошибка доступа

Аутентификация

В данный момент доступно 2 метода аутентификации/идентификации.

Все залогиненные пользователи имеют доступ к Api v3, по куке COOKIEID1.

oAuth2

Получить токен можно запросом POST /api/v3/auth/access_token, используя grant_type=password:

Например:

curl --request POST \
    --url http://megaplan.local/api/v3/auth/access_token \
    --header 'content-type: multipart/form-data;' \
    --form [email protected] \
    --form password=123 \
    --form grant_type=password

Ответ:

    {
        "access_token": "YzE5OWEwM...",
        "expires_in": 172800,
        "token_type": "bearer",
        "scope": null,
        "refresh_token": "YTIzNTM4NW..."
    }

Далее access_token нужно передавать с каждым запросом к Api. Передавать может через GET параметр access_token или заголовок AUTHORIZATION.

Пример передачи access_token в GET параметрах:

/api/v3/offer?{"access_token":"MmMzNDc1NTQzN..."}

При передаче access_token в заголовке AUTHORIZATION:

AUTHORIZATION: Bearer MmMzNDc1NTQzN...

Запрос можно отправлять без дополнительных параметров

/api/v3/offer

Типы данных

Api оперирует следующими типами данных:

Сущности
Специальный тип данных для идентификации сложных ресурсов мегаплана. Представляет из себя JSON объект с полям, среди которых обязательно присутствует contentType, который содержит название сущности. Для передачи вложенной сущности достаточно передать ее contentType и id. Все поддерживаемые сущности описаны в разделе сущности.

Тип запроса влияет на количество полей в ответной сущности: если запрошена коллекция сущностей, то в ответ будут включены только поля, отмеченные в таблице в колонке в коллекции. Если необходимы все поля, то необходимо запросить конкретную сущность по ее id.

Скалярные типы
Скалярные типы включают в себя: integer, float, string.

Специальные типы
Тип any может включать в себе все возможные типы. Тип BaseEntity может включать в себе все возможные сущности.

Линк-сущности
В качестве вложенных сущностей (которые предназначены для ссылок, а не для сохранений) API ожидает так называемые линк-сущности - это сущности у которых есть всего два поля: ContentType и id, которые однозначно могут ссылаться на конкретную сущность.

Коллекция сущностей
Представляет из себя массив сущностей определенного типа.

Объединение сущностей
Представляет из себя объединение нескольких типов сущностей, которые могут быть одновременно в одном поле.

Объединение коллекций сущностей
Представляет из себя коллекцию сущностей, которая может содержать одновременно несколько типов сущностей.


Пагинация

Для пагинации коллекции используйте следующие параметры в запросе:

limit содержит количество элементов для вывода. По умолчанию равен 100.
pageAfter принимает линк-сущность и отобразит limit элементов, начиная с переданного.
pageBefore принимает линк-сущность и отобразит limit элементов, перед переданным.

С пагинируемой коллекцией в metadata обязательно возвращается поле pagination с полями:

Поле Описание
count Общее количество сущностей в ответе
limit Лимит количества сущностей в ответе.



Attaches

2
Контроллер вложений

GET
/api/v3/attache/archive

Описание

Скачать файлы в архиве

Параметры в запросе
Название Тип Описание
files* Коллекция

Возможные типы: integer

list of files ids

Тип ответа
File



GET
/api/v3/attache/shareUrl/{id}

Описание

Генератор публичных ссылок

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
ShareUrl




Autocomplete

5

GET
/api/v3/autocomplete

Параметры в запросе
Название Тип Описание
querySearch string

filter Объединение
Возможные типы:
string

BaseEntity

excludes Коллекция

Возможные типы: BaseEntity

limit integer

fields any

onlyRequestedFields boolean

отдавать только перечисленные поля

endpoint* string

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/autocomplete/anyTypes

Параметры в запросе
Название Тип Описание
contentTypes* Коллекция

Возможные типы: string

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/autocomplete/mentions

Параметры в запросе
Название Тип Описание
querySearch string

filter Объединение
Возможные типы:
string

BaseEntity

excludes Коллекция

Возможные типы: BaseEntity

limit integer

fields any

onlyRequestedFields boolean

отдавать только перечисленные поля

endpoint* string

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/autocomplete/groupEmployees

Параметры в запросе
Название Тип Описание
endpoint* string

group* Объединение
Возможные типы:
Group

Department

Position

isMultiple boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/autocomplete/issuePossibleParents

Параметры в запросе
Название Тип Описание
querySearch string

filter Объединение
Возможные типы:
string

BaseEntity

excludes Коллекция

Возможные типы: BaseEntity

limit integer

fields any

onlyRequestedFields boolean

отдавать только перечисленные поля

endpoint* string

Тип ответа
Коллекция

Возможные типы:

Task

Project




Bulk

2

POST
/api/v3/bulk

Описание

Вызов bulk-операции

Тело запроса
BulkApiCall

Тип ответа
boolean



POST
/api/v3/bulk/getEntitiesByLinks

Описание

Получить полные сущности по link-сущностям.Сущности которые не существуют и при отсутствии доступа к ним - не вернутсяПорядок не гарантирован.

Тело запроса
Коллекция

Возможные типы: BaseEntity

Тип ответа
Коллекция

Возможные типы: BaseEntity




Chat

6

PUT
/api/v3/chat/sound

Тип ответа
boolean



DELETE
/api/v3/chat/sound

Тип ответа
boolean



GET
/api/v3/chat/totalUnreadCommentsCount

Тип ответа
integer



DELETE
/api/v3/chat

Тело запроса
Topic

Тип ответа
boolean



POST
/api/v3/chat/{id}/restore

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Topic



GET
/api/v3/chat/participants

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

Group




ChatListSearch

1
Контроллер, в котором производится поиск по списку переписок в чате

GET
/api/v3/chatListSearch

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Topic

Employee




Conference

3

POST
/api/v3/conference/join

Тело запроса
ConferenceRequest

Тип ответа
ConferenceRoomAuth



POST
/api/v3/conference/leave

Тело запроса
ConferenceRequest

Тип ответа
string



POST
/api/v3/conference/decline

Тело запроса
ConferenceRequest

Тип ответа
string




CurrentUser

2

GET
/api/v3/currentUser

Тип ответа
Объединение
Возможные типы:
Employee

ContractorHuman



POST
/api/v3/currentUser/loyalty

Параметры в запросе
Название Тип Описание
voteValue number

shareLink Коллекция

Возможные типы: any

feedbackMessage string

Тип ответа
string




DiagramInfo

1

GET
/api/v3/diagramInfo

Параметры в запросе
Название Тип Описание
endpoint* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
TaskDiagramInfo




ExtraFields

4

POST
/api/v3/extraFields

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/extraFields/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
BaseEntity



POST
/api/v3/extraFields/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
BaseEntity

Тип ответа
BaseEntity



DELETE
/api/v3/extraFields/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean




Favorite

1

GET
/api/v3/favorite

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity




FileStorage

1

GET
/api/v3/fileStorage

Параметры в запросе
Название Тип Описание
filter FileStorageFilter

q string

firstLevelFieldsLimitedOnly boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File




Filter

10
Контроллер для фильтров

POST
/api/v3/{entityType}Filter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/{entityType}Filter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/{entityType}Filter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/{entityType}Filter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/{entityType}Filter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/{entityType}Filter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/{entityType}Filter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/{entityType}Filter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/{entityType}Filter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/{entityType}Filter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




GoogleCalendarSync

2
Контроллер для работы с сотрудниками

GET
/api/v3/googleCalendarSync/googleCalendarEmail/{caldavSyncSettingId}

Описание

Получение почты гугл календаря

Параметры в запросе
Название Тип Описание
caldavSyncSettingId* integer

Тип ответа
string



POST
/api/v3/googleCalendarSync/saveGoogleSyncSetting/{caldavSyncSettingId}/{calendarId}

Описание

Сохранение настроек гугл календаря

Параметры в запросе
Название Тип Описание
caldavSyncSettingId* integer

calendarId* string

Тип ответа
string




HardCode

2

POST
/api/v3/hardcode/customerData

Тело запроса
CustomerData

Тип ответа
CustomerData



POST
/api/v3/hardcode/mailToMegaplanEdu

Тело запроса
CustomerMessage

Тип ответа
boolean




MassAction

1
Контроллер массовых действий

POST
/api/v3/massAction

Описание

Запускает массовое действие

Тело запроса
Объединение
Возможные типы:
MassActionApplyTrigger

MassActionChangeProgramState

MassActionCreateConsignment

MassActionDelete

MassActionDoAction

MassActionEditField

MassActionEntitiesToFilters

MassActionLinkEntities

MassActionUnlinkEntities

Тип ответа
Коллекция

Возможные типы:

MassActionResult

BaseEntity

boolean




Menu

6

GET
/api/v3/menu/staffCanHideMenuItem

Тип ответа
SystemSetting



POST
/api/v3/menu/staffCanHideMenuItem

Тело запроса
SystemSetting

Тип ответа
SystemSetting



GET
/api/v3/menu/defaultUrl

Описание

Возващает дефолтный урл для пользователя

Тип ответа
string



GET
/api/v3/menu

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MenuItem



GET
/api/v3/menu/{id}

Описание

Возващает один пункт меню

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
MenuItem



POST
/api/v3/menu

Тело запроса
Коллекция

Возможные типы: MenuItem

Тип ответа
Коллекция

Возможные типы: MenuItem




MenuCustomItem

5

GET
/api/v3/menuCustomItem

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MenuItem



GET
/api/v3/menuCustomItem/active

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MenuItem



GET
/api/v3/menuCustomItem/{id}/children

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MenuItem



GET
/api/v3/menuCustomItem/{id}

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тип ответа
MenuItem



POST
/api/v3/menuCustomItem/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
MenuItem

Тип ответа
MenuItem




Messengers

1

GET
/api/v3/messengers

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MessengerChannel




Negotiation

3

POST
/api/v3/negotiation/{id}/reject

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
NegotiationVisa

Тип ответа
NegotiationItem



POST
/api/v3/negotiation/{id}/approve

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
NegotiationVisa

Тип ответа
NegotiationItem



POST
/api/v3/negotiation/{id}/version

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
NegotiationItemVersion

Тип ответа
NegotiationItemVersion




OnBoardingProgram

3

GET
/api/v3/onboardingProgram/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
OnBoardingProgramTutorial



POST
/api/v3/onboardingProgram/{id}/next

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
OnBoardingProgramTutorial



POST
/api/v3/onboardingProgram/{id}/cancel

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
OnBoardingProgramTutorial




ReportObject

3

GET
/api/v3/report/object

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ReportObject



GET
/api/v3/report/object/forDesktop

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ReportObject



GET
/api/v3/report/object/{objectType}

Параметры в запросе
Название Тип Описание
objectType* string

programId integer

contextEntity BaseEntity

Тип ответа
ReportObject




ReportTemplate

1
Отчеты

GET
/api/v3/report_template/{templateId}/data

Описание

Получение данных отчета

Параметры в запросе
Название Тип Описание
templateId* integer

offset integer

Номер страницы

limit integer

Количество записей на странице

sortby Коллекция

Возможные типы: string

Сортировка

filters Коллекция

Возможные типы: string

Фильтры

clearCache boolean

Тип ответа
ReportData




Search

1

GET
/api/v3/search

Параметры в запросе
Название Тип Описание
contentTypes Коллекция

Возможные типы: string

q string

limit integer

fields any

Тип ответа
Коллекция

Возможные типы: SearchGroup




Support

1
Класс для функций связанных с поддержкой пользователей

POST
/api/v3/support/feedback

Описание

Экшен сборки фидбека

Тело запроса
FeedbackRequest

Тип ответа
boolean




Time

1
Контроллер для работы с делами

GET
/api/v3/time

Описание

Получение списка дел

Параметры в запросе
Название Тип Описание
filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Todo




UsersByUids

1

GET
/api/v3/usersByUids

Параметры в запросе
Название Тип Описание
uids* Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee




Widget

4
Контроллер для работы c виджетами рабочего стола

GET
/api/v3/desktop/widget

Описание

Список виджетов сотрудника

Параметры в запросе
Название Тип Описание
filters Коллекция

Возможные типы: string

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

page integer

limit integer

Сколько элементов включать в страницу.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

fields any

Набор дополнительных полей, включённых в список

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ActivityDesktopWidget

CrmDesktopWidget

InvoiceDesktopWidget

ReportDesktopWidget

ExampleDesktopWidget

EmployeeBirthdayDesktopWidget

EmployeeEffectivenessDesktopWidget

TaskDesktopWidget

TodoDesktopWidget

DealDesktopWidget



POST
/api/v3/desktop/widget/{widgetId}

Описание

Добавление/обновление виджета

Параметры в запросе
Название Тип Описание
widgetId* string

Тело запроса
Объединение
Возможные типы:
ActivityDesktopWidget

CrmDesktopWidget

InvoiceDesktopWidget

ReportDesktopWidget

ExampleDesktopWidget

EmployeeBirthdayDesktopWidget

EmployeeEffectivenessDesktopWidget

TaskDesktopWidget

TodoDesktopWidget

DealDesktopWidget

Тип ответа
Объединение
Возможные типы:
ActivityDesktopWidget

CrmDesktopWidget

InvoiceDesktopWidget

ReportDesktopWidget

ExampleDesktopWidget

EmployeeBirthdayDesktopWidget

EmployeeEffectivenessDesktopWidget

TaskDesktopWidget

TodoDesktopWidget

DealDesktopWidget





GET
/api/v3/desktop/widget/list

Описание

Список доступных виджетов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\api\v03\todo\Entity\Todo

44
Контроллер событий

POST
/api/v3/todo

Описание

Создание события

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/todo

Описание

Возвращает список событий

Параметры в запросе
Название Тип Описание
filter TodoFilter

ignoreRights boolean

q string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Todo



GET
/api/v3/todo/busyDays

Описание

Возвращает агрегированную информацию по делам

Параметры в запросе
Название Тип Описание
filter TodoFilter

ignoreRights boolean

q string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TodosBusyDay



GET
/api/v3/todo/{id}

Описание

Возващает одно событие

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Todo



POST
/api/v3/todo/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Todo

Тип ответа
Todo



POST
/api/v3/todo/{id}/{changeMode}

Описание

Обновление события запросом.Позволяет изменить событие с расписанием.

Параметры в запросе
Название Тип Описание
changeMode* string

способ изменения:<br/><b>this</b> - только выбранное событие<br/><b>next</b> - выбранное и все последующие будут изменены.<br/><b>all</b> - все мероприятия включая шаблон будут изменены.<br/>

Тело запроса
Todo

Тип ответа
Todo



POST
/api/v3/todo/{id}/doAction

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
Объединение
Возможные типы:
TodoAcceptInvitationActionRequest

TodoDeleteRepeatableActionRequest

TodoFinishActionRequest

TodoRejectInvitationActionRequest

TodoRenewActionRequest

TodoTakeActionRequest

Тип ответа
Todo



POST
/api/v3/todo/{todoId}/participants

Параметры в запросе
Название Тип Описание
todoId* integer

Тело запроса
Participant

Тип ответа
Todo



POST
/api/v3/todo/{todoId}/nextParticipants

Параметры в запросе
Название Тип Описание
todoId* integer

Тело запроса
Participant

Тип ответа
boolean



GET
/api/v3/todo/{id}/participants

Описание

Получение всех участников дела

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Participant



DELETE
/api/v3/todo/{todoId}/participants/{participantContentType}/{participantId}

Параметры в запросе
Название Тип Описание
todoId* integer

participantContentType* string

participantId* integer

Тип ответа
Todo



DELETE
/api/v3/todo/{todoId}/nextParticipants/{participantContentType}/{participantId}

Параметры в запросе
Название Тип Описание
todoId* integer

participantContentType* string

participantId* integer

Тип ответа
Todo



DELETE
/api/v3/todo/{id}

Описание

Удаление события

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Todo



POST
/api/v3/todo/{id}/deleteRequest

Описание

Удаление события с запросом.Позволяет выбирать, что именно нужно удалить в событии с расписанием.

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
TodoDeleteRepeatableActionRequest

Тип ответа
Todo



GET
/api/v3/todo/parse

Параметры в запросе
Название Тип Описание
text string

hints ParseHints

Тип ответа
ParsedStruct



POST
/api/v3/todo/{todoId}/schedule/{changeMode}

Описание

Обновить расписание

Параметры в запросе
Название Тип Описание
todoId* integer

changeMode* string

Тело запроса
Schedule

Тип ответа
Todo



DELETE
/api/v3/todo/{todoId}/schedule

Описание

Удалить расписание

Параметры в запросе
Название Тип Описание
todoId* integer

Тип ответа
Todo



GET
/api/v3/todo/reminderTransports

Описание

Возможные транспорты для напоминаний

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string



GET
/api/v3/todo/{todoId}/coincidentTodos

Описание

Дела в этоже время

Параметры в запросе
Название Тип Описание
todoId* string

*

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Todo



GET
/api/v3/todo/{entityId}/issues

Описание

Отдаёт все связанные задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/todo/{entityId}/deals

Описание

Отдаёт все связанные сделки

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/todo/{entityId}/linkedDealsPrograms

Описание

Отдаёт схемы связанных сделок

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/todo/{id}/deals/extraFields

Описание

Возвращает дополнительные поля программы

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

fieldNames Коллекция

Возможные типы: string

Массив названий запрашиваемых полей

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/todo/{todoId}/changeLinksWithSchedule/{action}

Описание

Связывает сущности от дел с расписанием

Параметры в запросе
Название Тип Описание
todoId* integer

action* string

Тело запроса
Коллекция

Возможные типы: BaseEntity

Тип ответа
Коллекция

Возможные типы:

MassActionResult

BaseEntity



GET
/api/v3/todo/{id}/allParticipants

Описание

Получение всех текущих участников дела

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/todo/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/todo/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/todo/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/todo/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/todo/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/todo/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/todo/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/todo/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/todo/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/todo/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/todo/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/todo/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/todo/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/todo/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/todo/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



POST
/api/v3/todo/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/todo/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/todo/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/todo/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\common\api\v03\todo\Entity\TodoCategory

1

GET
/api/v3/todoCategory

Описание

Возвращает список категорий дел

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TodoCategory




bums\common\api\v03\todo\Entity\TodoStatus

1

GET
/api/v3/todoStatus

Описание

Возвращает список статусов для дел

Параметры в запросе
Название Тип Описание
masterType string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TodoStatus




bums\common\common\api\v03\Entity\Approval

2
Контроллер сущностей Approval

GET
/api/v3/approval

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Approval



GET
/api/v3/approval/counter

Тип ответа
Counter




bums\common\common\api\v03\Entity\Burning

2
Контроллер сущностей Burning

GET
/api/v3/burning

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Burning



GET
/api/v3/burning/counter

Тип ответа
Counter




bums\common\common\api\v03\Entity\CalculatedField

4

POST
/api/v3/calculatedField/{id}

Описание

Создание

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
CalculatedField

Тип ответа
CalculatedField



DELETE
/api/v3/calculatedField/{id}

Описание

Удаление

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
void



GET
/api/v3/calculatedField/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
CalculatedField



GET
/api/v3/calculatedField

Параметры в запросе
Название Тип Описание
subject BaseEntity

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CalculatedField




bums\common\common\api\v03\Entity\Changeset

1
Контроллер сущностей Changeset

GET
/api/v3/changeset/{id}

Описание

Получить один ченджсет по id

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Changeset




bums\common\common\api\v03\Entity\City

4

GET
/api/v3/city

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: City



GET
/api/v3/city/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
City



POST
/api/v3/city

Тело запроса
City

Тип ответа
City



GET
/api/v3/city/{id}/metros

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Metro




bums\common\common\api\v03\Entity\Comment

13
Главный контроллер комментариев, через которые их можно обновлять и удалять.

POST
/api/v3/comment/{id}

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор комментария

Тело запроса
Comment

Тип ответа
Comment



DELETE
/api/v3/comment/{id}

Описание

Экшн псевдо-удаления комментария.Дублирует update с isDropped.Сделано для красоты публичного апи.

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Comment



GET
/api/v3/comment/{entityId}/attaches

Параметры в запросе
Название Тип Описание
entityId* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/comment/{id}

Описание

Получить комментарий

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Comment



GET
/api/v3/comment/{id}/like

Описание

Получить список лайков комментария

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности комментария

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/comment/{id}/answers

Описание

Возвращает список всех ответов на комментарий и овтетов к ответам

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/comment/{id}/forward

Описание

Переслать комментарий в другую сущность

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности комментария

subject BaseEntity

Тип ответа
Comment



POST
/api/v3/comment/{entityId}/relationLinks/{id}

Описание

Добавление/обновление ссылок

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор ссылки

Тело запроса
RelationLink

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/comment/{entityId}/relationLinks

Описание

Получение списка связей для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/comment/{entityId}/relationLinks/{id}

Описание

Получение связи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор связи

Тип ответа
RelationLink



DELETE
/api/v3/comment/{entityId}/relationLinks/{id}

Описание

Удаление связной ссылки

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор сущности

id* integer

Идентификатор ссылки

Тип ответа
boolean



GET
/api/v3/comment/{id}/links

Описание

Все связанные ссылки задачи и ее комментариев

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/comment/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\common\common\api\v03\Entity\CommentTemplate

8

GET
/api/v3/commentTemplate/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
CommentTemplate



GET
/api/v3/commentTemplate

Параметры в запросе
Название Тип Описание
key string

type string

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CommentTemplate



DELETE
/api/v3/commentTemplate/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Response



POST
/api/v3/commentTemplate

Тело запроса
CommentTemplate

Тип ответа
CommentTemplate



POST
/api/v3/commentTemplate/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
CommentTemplate

Тип ответа
CommentTemplate



GET
/api/v3/commentTemplate/variables/{type}/{programId}

Параметры в запросе
Название Тип Описание
type* string

programId* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Variable



POST
/api/v3/commentTemplate/preparedTemplate/{templateId}

Параметры в запросе
Название Тип Описание
templateId* integer

Тело запроса
BaseEntity

Тип ответа
string



GET
/api/v3/commentTemplate/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File




bums\common\common\api\v03\Entity\Counter

2
Common controller for all Counter entities

GET
/api/v3/counter

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Counter



GET
/api/v3/counter/{counterId}

Параметры в запросе
Название Тип Описание
counterId* string

Тип ответа
Counter




bums\common\common\api\v03\Entity\Country

1

GET
/api/v3/country

Описание

Список возможных стран

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Country




bums\common\common\api\v03\Entity\DiskSpace

2
Контроллер apiv3 для работы с файлами

GET
/api/v3/diskSpace

Описание

Информация о занятости файлового хранилища

Тип ответа
DiskSpace



GET
/api/v3/diskSpace/hideApproval

Тип ответа
boolean




bums\common\common\api\v03\Entity\ExperimentalModule

2

GET
/api/v3/experimentalModule

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ExperimentalModule



POST
/api/v3/experimentalModule/{id}

Тело запроса
ExperimentalModule

Тип ответа
ExperimentalModule




bums\common\common\api\v03\Entity\ExternalWindow

2

GET
/api/v3/externalWindow/current

Тип ответа
ExternalWindow



POST
/api/v3/externalWindow/close

Тело запроса
ExternalWindow

Тип ответа
any




bums\common\common\api\v03\Entity\Feature

3

GET
/api/v3/feature

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Feature



POST
/api/v3/feature/handleTestDrive

Тело запроса
Variable

Тип ответа
Feature



POST
/api/v3/feature/verifyFeature

Параметры в запросе
Название Тип Описание
feature string

Тип ответа
void




bums\common\common\api\v03\Entity\File

2
Контроллер apiv3 для работы с файлами

POST
/api/v3/file/{id}/updateMetadata

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Объединение
Возможные типы:
ImageFileMetadata

AudioFileMetadata

Тип ответа
File



DELETE
/api/v3/file/{id}

Описание

Удаление файлов

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean




bums\common\common\api\v03\Entity\FilterGroup

4

GET
/api/v3/filterGroup

Параметры в запросе
Название Тип Описание
type string

program Program

Тип ответа
Коллекция

Возможные типы: FilterGroup



GET
/api/v3/filterGroup/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
FilterGroup



POST
/api/v3/filterGroup

Параметры в запросе
Название Тип Описание
id string

Тело запроса
FilterGroup

Тип ответа
FilterGroup



DELETE
/api/v3/filterGroup/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
any




bums\common\common\api\v03\Entity\Filter\ConsignmentFilter

10

POST
/api/v3/consignmentFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/consignmentFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/consignmentFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/consignmentFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/consignmentFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/consignmentFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/consignmentFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/consignmentFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/consignmentFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/consignmentFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\CrmFilter

10

POST
/api/v3/crmFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/crmFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/crmFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/crmFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/crmFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/crmFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/crmFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/crmFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/crmFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/crmFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\CustomCrmFilter

1

GET
/api/v3/customCrmFilter

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter




bums\common\common\api\v03\Entity\Filter\DocFilter

10

POST
/api/v3/docFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/docFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/docFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/docFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/docFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/docFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/docFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/docFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/docFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/docFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\EmployeeFilter

10

GET
/api/v3/employeeFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



POST
/api/v3/employeeFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/employeeFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/employeeFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/employeeFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/employeeFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/employeeFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/employeeFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/employeeFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/employeeFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\FileStorageFilter

10

POST
/api/v3/fileStorageFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/fileStorageFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/fileStorageFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/fileStorageFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/fileStorageFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/fileStorageFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/fileStorageFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/fileStorageFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/fileStorageFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/fileStorageFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\IntegrationFilter

10

POST
/api/v3/integrationFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/integrationFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/integrationFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/integrationFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/integrationFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/integrationFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/integrationFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/integrationFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/integrationFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/integrationFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\OfferFilter

10

GET
/api/v3/offerFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает экспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



POST
/api/v3/offerFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/offerFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/offerFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/offerFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/offerFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/offerFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/offerFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/offerFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/offerFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\TaskFilter

11

GET
/api/v3/taskFilter/{id}/diagramInfo

Описание

Возвращает параметры диаграммы для выбранного фильтра

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
TaskDiagramInfo



POST
/api/v3/taskFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/taskFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/taskFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/taskFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/taskFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/taskFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/taskFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/taskFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/taskFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/taskFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Filter\TradeFilter

13

POST
/api/v3/tradeFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/tradeFilter/{filterCompositeId}

Параметры в запросе
Название Тип Описание
filterCompositeId* string

Тело запроса
TradeFilter

Тип ответа
TradeFilter



GET
/api/v3/tradeFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

programId string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string



GET
/api/v3/tradeFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

programId string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/tradeFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/tradeFilter/{filterCompositeId}

Параметры в запросе
Название Тип Описание
filterCompositeId* string

Тип ответа
TradeFilter



GET
/api/v3/tradeFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/tradeFilter/{programId}

Описание

Получение не системных фильтров сделок по programId

Параметры в запросе
Название Тип Описание
programId* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TradeFilter



DELETE
/api/v3/tradeFilter/{filterCompositeId}

Параметры в запросе
Название Тип Описание
entityType* string

filterCompositeId* string

Тип ответа
boolean



POST
/api/v3/tradeFilter/{filterCompositeId}/leave

Параметры в запросе
Название Тип Описание
entityType* string

filterCompositeId* string

Тип ответа
boolean



POST
/api/v3/tradeFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/tradeFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/tradeFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter




bums\common\common\api\v03\Entity\Filter\WarehouseFilter

10

POST
/api/v3/warehouseFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тело запроса
NewFilterSettingsRequest

Тип ответа
UserSetting



POST
/api/v3/warehouseFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тело запроса
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



DELETE
/api/v3/warehouseFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



POST
/api/v3/warehouseFilter/{id}/leave

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
boolean



GET
/api/v3/warehouseFilter/export

Описание

Запускает экспорт, отдает file или null, что подразумевает эжкспорт произошел сразу или ушел в джоб

Параметры в запросе
Название Тип Описание
filter Filter

query string

fields Коллекция

Возможные типы: string

Тип ответа
FilterExport



GET
/api/v3/warehouseFilter/availableResponsibles

Описание

Возвращает список доступных сотрудников и клиентов с ГД

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany



GET
/api/v3/warehouseFilter/{id}/newFilterSettings

Параметры в запросе
Название Тип Описание
id* string

- id фильра или программы

entityType* string

Тип ответа
UserSetting



GET
/api/v3/warehouseFilter/{id}

Параметры в запросе
Название Тип Описание
entityType* string

id* string

Тип ответа
Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

boolean



GET
/api/v3/warehouseFilter

Описание

Возвращает список фильтров сущности

Параметры в запросе
Название Тип Описание
entityType* string

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter



GET
/api/v3/warehouseFilter/formula/variables

Описание

Возвращает список допустимых переменных для фильтрации по формуле

Параметры в запросе
Название Тип Описание
entityType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\common\common\api\v03\Entity\Group

3

GET
/api/v3/group

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Group



GET
/api/v3/group/{id}/participants

Описание

Список участников группы

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Group



GET
/api/v3/group/allStaffGroup

Тип ответа
Group




bums\common\common\api\v03\Entity\Holiday

1

GET
/api/v3/holiday

Описание

Получить список праздников

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Holiday




bums\common\common\api\v03\Entity\HolidayDay

3

GET
/api/v3/holidayDay

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: HolidayDay



POST
/api/v3/holidayDay

Описание

Сохранить праздничный день

Тело запроса
HolidayDay

Тип ответа
any



DELETE
/api/v3/holidayDay/{id}

Описание

Удалить праздничный день

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean




bums\common\common\api\v03\Entity\HolidaysProvider

2

GET
/api/v3/holidaysProvider

Описание

Получить список стран-провайдеров для синхронизации

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: HolidaysProvider



POST
/api/v3/holidaysProvider/syncHolidays

Описание

Синхронизировать список праздничных дней по стране

Параметры в запросе
Название Тип Описание
providerId* string

Тип ответа
Коллекция

Возможные типы: HolidayDay




bums\common\common\api\v03\Entity\Interaction

1

GET
/api/v3/interaction/recent

Описание

Последние открытые сущности

Параметры в запросе
Название Тип Описание
action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Interaction




bums\common\common\api\v03\Entity\Metro

3

GET
/api/v3/metro

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Metro



GET
/api/v3/metro/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Metro



POST
/api/v3/metro

Тело запроса
Metro

Тип ответа
Metro




bums\common\common\api\v03\Entity\News

2
Контроллер сущностей News

GET
/api/v3/news

Параметры в запросе
Название Тип Описание
force boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: News



GET
/api/v3/news/counter

Тип ответа
Counter




bums\common\common\api\v03\Entity\Notification

10

GET
/api/v3/notification/activity

Описание

Лента активности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Notification



GET
/api/v3/notification/activityTypes

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: NotificationType



DELETE
/api/v3/notification/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
boolean



DELETE
/api/v3/notification/all

Тип ответа
boolean



GET
/api/v3/notification

Параметры в запросе
Название Тип Описание
isActive boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Notification



GET
/api/v3/notification/united

Параметры в запросе
Название Тип Описание
filter Коллекция

Возможные типы: string

isActive boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Notification

Burning

Approval



GET
/api/v3/notification/counter

Тип ответа
Counter



POST
/api/v3/notification/deviceToken

Тело запроса
DeviceTokenRequest

Тип ответа
boolean



DELETE
/api/v3/notification/deviceToken

Тело запроса
DeviceTokenRequest

Тип ответа
boolean



GET
/api/v3/notification/{id}/access

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
boolean




bums\common\common\api\v03\Entity\OpenGraph

1

GET
/api/v3/openGraph

Параметры в запросе
Название Тип Описание
url* string

Тип ответа
OpenGraph




bums\common\common\api\v03\Entity\Place

2

GET
/api/v3/place

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Place



POST
/api/v3/place

Описание

Создание места

Тело запроса
Place

Тип ответа
Place




bums\common\common\api\v03\Entity\ProductQuest

2

GET
/api/v3/productQuest

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ProductQuest



GET
/api/v3/productQuest/{id}

Описание

Получение отдельного квеста

Параметры в запросе
Название Тип Описание
id* string

Идентификатор

Тип ответа
ProductQuest




bums\common\common\api\v03\Entity\ProductQuestItem

3

GET
/api/v3/productQuestItem

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ProductQuestItem



GET
/api/v3/productQuestItem/{id}

Описание

Получение отдельного квеста

Параметры в запросе
Название Тип Описание
id* string

Идентификатор

Тип ответа
ProductQuestItem



POST
/api/v3/productQuestItem/{id}

Описание

Обновление

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
ProductQuestItem

Тип ответа
ProductQuestItem




bums\common\common\api\v03\Entity\RelationLink

1

POST
/api/v3/relationLink/{id}/updateMetadata

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
RelationLinkMetadata

Тип ответа
RelationLink




bums\common\common\api\v03\Entity\Statistic

1
API получения статистики аккаунта за указанный год

GET
/api/v3/statistic/{year}

Описание

Возващает статистику за указанный год

Параметры в запросе
Название Тип Описание
year* integer

Тип ответа
Statistic




bums\common\common\api\v03\Entity\TreeNode

1
Контроллер сохранения expanded поля treeNode

POST
/api/v3/treeNode/{id}

Описание

Сохраняет только значение поля expanded для treeNode

Тело запроса
TreeNode

Тип ответа
any




bums\common\common\api\v03\Entity\UserInterfaceLayout

3
Контроллер пользователських настроек макета карточек

GET
/api/v3/userInterfaceLayout

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: UserInterfaceLayout



GET
/api/v3/userInterfaceLayout/{type}

Описание

Получить UserInterfaceLayout по id

Параметры в запросе
Название Тип Описание
type* string

id string

Тип ответа
UserInterfaceLayout



POST
/api/v3/userInterfaceLayout/{type}

Описание

Создать/обновить UserInterfaceLayout

Параметры в запросе
Название Тип Описание
type* string

id string

Тело запроса
UserInterfaceLayoutRequest

Тип ответа
UserInterfaceLayout




bums\common\common\api\v03\Entity\UserSetting

2
Контроллер пользователських настроек

GET
/api/v3/userSetting/{id}

Описание

Получить глобальную настройку по имени, или по списку имён.

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
UserSetting



POST
/api/v3/userSetting

Описание

Создать/обновить настройку

Тело запроса
UserSetting

Тип ответа
UserSetting




bums\common\common\api\v03\Entity\WeekendDay

2

GET
/api/v3/weekendDay

Описание

Получить список выходных дней

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: WeekendDay



POST
/api/v3/weekendDay

Описание

Сохранить список выходных дней в недели

Параметры в запросе
Название Тип Описание
days Коллекция

Возможные типы: string

Тип ответа
boolean




bums\common\import\api\v03\Entity\ImportColumn

2

POST
/api/v3/importColumn/{id}

Описание

Обновление колонки

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
ImportColumn

Тип ответа
ImportColumn



GET
/api/v3/importColumn/{id}

Описание

Возващает одну колонку

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
ImportColumn




bums\common\import\api\v03\Entity\ImportRow

2

POST
/api/v3/importRow/{id}

Описание

Обновление строки

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
ImportRow

Тип ответа
ImportRow



GET
/api/v3/importRow/{id}

Описание

Возващает одну строку импорта

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
ImportRow




bums\common\mail\api\v03\Entity\Imap

8

GET
/api/v3/imap

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Imap



GET
/api/v3/imap/{id}

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
Imap



DELETE
/api/v3/imap/{id}

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
boolean



POST
/api/v3/imap/{id}

Описание

Обновление

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тело запроса
Imap

Тип ответа
Imap



POST
/api/v3/imap

Описание

Создание

Тело запроса
Imap

Тип ответа
Imap



GET
/api/v3/imap/{id}/visibleFor

Описание

Получение кому расшарено

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group



POST
/api/v3/imap/{id}/visibleFor

Описание

Расшаривание

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тело запроса
Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Тип ответа
boolean



DELETE
/api/v3/imap/{id}/visibleFor/{visibleForContentType}/{visibleForId}

Описание

Удаление из расшаренных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

visibleForContentType* string

тип

visibleForId* integer

Идентификатор

Тип ответа
boolean




bums\common\mail\api\v03\Entity\MailServerConfig

1

GET
/api/v3/mailServerConfig

Описание

Определение настроек imap и smtp в автоматическом режиме по email

Параметры в запросе
Название Тип Описание
email* string

example [email protected]

password string

example password in base64

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MailServerConfig




bums\common\mail\api\v03\Entity\Smtp

8

GET
/api/v3/smtp

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/smtp/{id}

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
Smtp



DELETE
/api/v3/smtp/{id}

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
boolean



POST
/api/v3/smtp/{id}

Описание

Обновление

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тело запроса
Smtp

Тип ответа
Smtp



POST
/api/v3/smtp

Описание

Создание

Тело запроса
Smtp

Тип ответа
Smtp



GET
/api/v3/smtp/{id}/visibleFor

Описание

Получение кому расшарено

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group



POST
/api/v3/smtp/{id}/visibleFor

Описание

Расшаривание

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тело запроса
Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Тип ответа
boolean



DELETE
/api/v3/smtp/{id}/visibleFor/{visibleForContentType}/{visibleForId}

Описание

Удаление из расшаренных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

visibleForContentType* string

тип

visibleForId* integer

Идентификатор

Тип ответа
boolean




bums\common\messenger\api\v03\Entity\Messenger

5
Контроллер для работы с мессенджерами

GET
/api/v3/messenger

Описание

Получение списка мессенджеров

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Messenger



GET
/api/v3/messenger/{id}

Описание

Получение отдельного мессенджера

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
Messenger



POST
/api/v3/messenger

Описание

Добавление мессенджера - возможно только из под интеграций

Тело запроса
Messenger

Тип ответа
Messenger



DELETE
/api/v3/messenger/{id}

Описание

Удаление мессенджера - из под интеграции

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
boolean



POST
/api/v3/messenger/{id}

Описание

Обновление мессенджера - возможно только из под интеграций

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Messenger

Тип ответа
Messenger




bums\common\messenger\api\v03\Entity\MessengerChannel

8
Контроллер для работы с каналами мессенджеров

GET
/api/v3/messengerChannel

Описание

Получение списка

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MessengerChannel



GET
/api/v3/messengerChannel/{id}

Описание

Получение отдельного канала

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
MessengerChannel



POST
/api/v3/messengerChannel

Описание

Добавление канала

Тело запроса
MessengerChannel

Тип ответа
MessengerChannel



DELETE
/api/v3/messengerChannel/{id}

Описание

Удаление канала

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
boolean



POST
/api/v3/messengerChannel/{id}

Описание

Обновление канала

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
MessengerChannel

Тип ответа
MessengerChannel



GET
/api/v3/messengerChannel/{id}/responsibles

Описание

Получение ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/messengerChannel/{id}/responsibles

Описание

Добавление ответственного

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Employee

Тип ответа
boolean



DELETE
/api/v3/messengerChannel/{id}/responsibles/{employeeId}

Описание

Удаление ответственного

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

employeeId* integer

Идентификатор ответственного

Тип ответа
boolean




bums\common\messenger\api\v03\Entity\MessengerType

4
Контроллер для работы с типами мессенджеров

GET
/api/v3/messengerType

Описание

Получение списка типов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: MessengerType



GET
/api/v3/messengerType/{id}

Описание

Получение отдельного типа

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор типа

Тип ответа
MessengerType



POST
/api/v3/messengerType

Описание

Добавление типа

Тело запроса
MessengerType

Тип ответа
MessengerType



DELETE
/api/v3/messengerType/{id}

Описание

Удаление типа

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор типа

Тип ответа
boolean




bums\common\productNews\api\v03\Entity\ProductNews

1

GET
/api/v3/productNews/{index}

Параметры в запросе
Название Тип Описание
index* integer

Тип ответа
ProductNews




bums\common\telegram\api\v03\Entity\TelegramMessage

2

GET
/api/v3/telegramMessage/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
TelegramMessage



POST
/api/v3/telegramMessage/{id}/resend

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
TelegramChannel

Тип ответа
Объединение
Возможные типы:
Message

WhatsappMessage

InstagramMessage

TelegramMessage




bums\common\wazzup\api\v03\Entity\InstagramMessage

1

GET
/api/v3/instagramMessage/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
InstagramMessage




bums\common\wazzup\api\v03\Entity\WhatsappMessage

2

GET
/api/v3/whatsappMessage/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
WhatsappMessage



POST
/api/v3/whatsappMessage/{id}/resend

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
WazzupChannel

Тип ответа
Объединение
Возможные типы:
Message

WhatsappMessage

InstagramMessage

TelegramMessage




bums\crm\api\v03\Entity\ContractorActivityType

1
Контроллер для списка видов деятельности клиента

GET
/api/v3/contractorActivityType

Описание

Получение списка типов клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorActivityType




bums\crm\api\v03\Entity\ContractorAdvertisingWay

1
Контроллер для списка каналов привличения

GET
/api/v3/contractorAdvertisingWay

Описание

Получение списка типов клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorAdvertisingWay




bums\crm\api\v03\Entity\ContractorImport

14

GET
/api/v3/contractorImport

Описание

Получение списка сессий

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorImport



GET
/api/v3/contractorImport/{id}/responsibles

Описание

Получение ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сессии импорта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/contractorImport/{id}/responsibles

Описание

Добавление ответственного в коллекцию

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сессии импорта

Тело запроса
Employee

Тип ответа
boolean



DELETE
/api/v3/contractorImport/{id}/responsibles/{responsibleId}

Описание

Удаление ответственного из коллекции

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сессии импорта

responsibleId* integer

Идентификатор ответственного сотрудника

Тип ответа
boolean



GET
/api/v3/contractorImport/{id}/duplicateRows

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сессии импорта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow



GET
/api/v3/contractorImport/{id}/incorrectDataRows

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сессии импорта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow



POST
/api/v3/contractorImport

Описание

Создание новой сессииобязательны поля destination и file

Тело запроса
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport

Тип ответа
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport



POST
/api/v3/contractorImport/{id}

Описание

Обновление сессии

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport

Тип ответа
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport



GET
/api/v3/contractorImport/{id}

Описание

Возващает одну сессию импорта

Параметры в запросе
Название Тип Описание
id* integer

recalcColumns boolean

Тип ответа
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport



DELETE
/api/v3/contractorImport/{id}

Описание

Удаление сессии

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean



GET
/api/v3/contractorImport/{id}/rows

Описание

Возващает строки импорта

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow



GET
/api/v3/contractorImport/{id}/columns

Описание

Возващает колонки импорта

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportColumn



GET
/api/v3/contractorImport/{id}/invalidatedRows

Описание

Возващает инвалидированные строки

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow



GET
/api/v3/contractorImport/{id}/errorRows

Описание

Возващает инвалидированные строки + строки с ошибками

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow




bums\crm\api\v03\Entity\ContractorStatus

1
Контроллер для списка статусов клиента

GET
/api/v3/contractorStatus

Описание

Получение списка типов клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorStatus




bums\crm\api\v03\Entity\LeadForm

4
Контроллер для работы с типами клиента

GET
/api/v3/leadForm

Описание

Получение списка форм

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: LeadForm



GET
/api/v3/leadForm/{id}

Описание

Получение отдельной формы

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

Тип ответа
LeadForm



POST
/api/v3/leadForm/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
LeadForm

Тип ответа
LeadForm



DELETE
/api/v3/leadForm/{id}

Описание

удаление формы лидов

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
LeadForm




bums\crm\api\v03\Entity\LoyaltyActionLogSet

1

GET
/api/v3/loyaltyActionLogSet/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
LoyaltyActionLogSet




bums\crm\api\v03\Entity\SendingLog

1

GET
/api/v3/sendingLog/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
SendingLog




bums\discuss\api\v03\Entity\Message

11

GET
/api/v3/message/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Message



POST
/api/v3/message/{id}/resend

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Объединение
Возможные типы:
Message

WhatsappMessage

InstagramMessage

TelegramMessage



GET
/api/v3/message

Параметры в запросе
Название Тип Описание
email string

isOutgoing boolean

withParent Message

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Message



GET
/api/v3/message/counter

Параметры в запросе
Название Тип Описание
email string

isOutgoing boolean

withParent Message

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Counter



POST
/api/v3/message/{id}/markAsRead

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Message



POST
/api/v3/message/send

Тело запроса
EmailTransportConfig

Тип ответа
Message



GET
/api/v3/message/transports

Описание

Получить доступные транспорты

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Smtp

Megamail



GET
/api/v3/message/searchContact

Параметры в запросе
Название Тип Описание
email string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: SearchContactResult



POST
/api/v3/message/{id}/forward

Описание

Переслать письмо в виде комментария в другую сущность

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности комментария

subject BaseEntity

Тип ответа
Comment



POST
/api/v3/message/{id}/convertToTask

Описание

Конвертировать письмо в задачу

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности комментария

Тип ответа
Task



GET
/api/v3/message/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\discuss\api\v03\Entity\RawMessage

1
Контроллер сырых сообщений (email, telegram и пр.)

POST
/api/v3/rawMessage

Описание

Принять новое необработанное сообщение

Тело запроса
RawMessage

Тип ответа
RawMessage




bums\discuss\api\v03\Entity\Topic

29
Главный контроллер топиков (без привязки к чату)

GET
/api/v3/topic

Параметры в запросе
Название Тип Описание
filters Коллекция

Возможные типы: string

folder TopicFolder

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Topic



GET
/api/v3/topic/attachedFirst

Описание

Вернуть список всех топиков, закрепленные сверху

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Topic



GET
/api/v3/topic/hidden

Описание

Вернуть список скрытых топиков, закрепленные сверху

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Topic



POST
/api/v3/topic

Параметры в запросе
Название Тип Описание
id integer

Тело запроса
Topic

Тип ответа
Topic



GET
/api/v3/topic/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Topic



GET
/api/v3/topic/{id}/participants

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group



POST
/api/v3/topic/{id}/participants

Описание

Добавление участника

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
ChangeParticipantsRequest

Тип ответа
Topic



POST
/api/v3/topic/{id}/read

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Topic



POST
/api/v3/topic/{id}/unread

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Topic



PUT
/api/v3/topic/{id}/attach

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean



DELETE
/api/v3/topic/{id}/attach

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean



GET
/api/v3/topic/{id}/folders

Описание

Возвращает список папок обсужденя

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TopicFolder



GET
/api/v3/topic/subordinatesChats

Описание

Возвращает список чатов подчиненных сотрудников, в которых отсутствует текущий пользователь

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Topic



GET
/api/v3/topic/{id}/allParticipants

Описание

Получение всех текущих участников топика

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/topic/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/topic/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/topic/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/topic/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/topic/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/topic/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/topic/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/topic/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/topic/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/topic/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/topic/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/topic/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/topic/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/topic/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/topic/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\discuss\api\v03\Entity\TopicFolder

5
Главный контроллер топиков (без привязки к чату)

GET
/api/v3/topicFolder

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TopicFolder



GET
/api/v3/topicFolder/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
TopicFolder



POST
/api/v3/topicFolder

Параметры в запросе
Название Тип Описание
id integer

Тело запроса
TopicFolder

Тип ответа
TopicFolder



DELETE
/api/v3/topicFolder/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean



POST
/api/v3/topicFolder/{id}/addTopic

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Topic

Тип ответа
TopicFolder




bums\doc\api\v03\Entity\Doc

35
Контроллер для работы с документами

POST
/api/v3/doc/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
Doc

Тип ответа
Doc



GET
/api/v3/doc/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
Doc



GET
/api/v3/doc/{id}/actualVersion

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
DocVersion



GET
/api/v3/doc/{id}/versionByRevision/{revision}

Параметры в запросе
Название Тип Описание
id* string

revision* string

Тип ответа
DocVersion



GET
/api/v3/doc

Параметры в запросе
Название Тип Описание
parentFolder DocFolder

filter DocFilter

q string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



GET
/api/v3/doc/{id}/versions

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DocVersion



DELETE
/api/v3/doc/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
boolean



GET
/api/v3/doc/{id}/linkedDocs

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



POST
/api/v3/doc/{id}/setActualVersion

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
DocVersion

Тип ответа
Doc



POST
/api/v3/doc/{id}/newVersion

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
File

Тип ответа
Doc



GET
/api/v3/doc/{id}/path

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DocFolder



GET
/api/v3/doc/{id}/inheritedRights

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DocRights



GET
/api/v3/doc/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



POST
/api/v3/doc/{id}/copy

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
Doc

Тип ответа
Doc



GET
/api/v3/doc/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/doc/tags

Описание

Получить варианты тегов для сущности

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/doc/tags/{id}

Описание

Создание/обновление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тело запроса
Tag

Тип ответа
Tag



DELETE
/api/v3/doc/tags/{id}

Описание

Удаление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тип ответа
Tag



GET
/api/v3/doc/{entityId}/tags

Описание

Получить все привязанные теги для конкретной сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



DELETE
/api/v3/doc/{entityId}/tags/{tagId}

Описание

Отвязать тег от сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

tagId* integer

Идентификатор тега

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/doc/{id}/tags

Описание

Добавление тегов сущности.Метку может добавлять любой сотрудник к любой сущности к которой у него есть доступ.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Tag

Тип ответа
BaseEntity



POST
/api/v3/doc/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/doc/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/doc/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



POST
/api/v3/doc/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/doc/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/doc/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/doc/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/doc/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/doc/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/doc/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/doc/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/doc/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/doc/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



GET
/api/v3/doc/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\doc\api\v03\Entity\DocFolder

5
Контроллер для работы с папками документов

GET
/api/v3/docFolder

Параметры в запросе
Название Тип Описание
parentFolder DocFolder

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DocFolder



POST
/api/v3/docFolder/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
DocFolder

Тип ответа
DocFolder



GET
/api/v3/docFolder/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
DocFolder



DELETE
/api/v3/docFolder/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
boolean



GET
/api/v3/docFolder/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity




bums\doc\api\v03\Entity\DocRights

3

POST
/api/v3/docRights/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
DocRights

Тип ответа
DocRights



GET
/api/v3/docRights/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
DocRights



DELETE
/api/v3/docRights/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
boolean




bums\doc\api\v03\Entity\DocVersion

3

POST
/api/v3/docVersion/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
DocVersion

Тип ответа
DocVersion



GET
/api/v3/docVersion/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
DocVersion



DELETE
/api/v3/docVersion/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
boolean




bums\fin\api\v03\Entity\FinOperation

11
Контроллер финансовых операций

POST
/api/v3/finOperation

Описание

Добавление финансовой операции

Тело запроса
FinOperation

Тип ответа
FinOperation



POST
/api/v3/finOperation/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
FinOperation

Тип ответа
FinOperation



GET
/api/v3/finOperation/{id}

Описание

Получение отдельной финансовой операции

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор операции

Тип ответа
FinOperation



POST
/api/v3/finOperation/createTransfer

Описание

Создание финансовых операций по переводу средств между счетами

Тело запроса
CreateFinTransferRequest

Тип ответа
FinOperation



GET
/api/v3/finOperation/types

Описание

Типы финансовых операций

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: any



POST
/api/v3/finOperation/{id}/linkWith

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Объединение
Возможные типы:
BaseEntity

CreateFinLinkRequest

Тип ответа
BaseEntity



GET
/api/v3/finOperation/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/finOperation/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/finOperation/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/finOperation/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/finOperation/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram




bums\integration\Api\v03\Entity\IntegrationWidget

7
Виджеты интеграции

GET
/api/v3/integrationWidget

Описание

Получение списка виджетов интеграций

Параметры в запросе
Название Тип Описание
placeholders Коллекция

Возможные типы: string

Виджеты по плейсхолдерам

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: IntegrationWidget



GET
/api/v3/integrationWidget/switchables

Описание

Получение списка виджетов интеграций

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: IntegrationWidget



GET
/api/v3/integrationWidget/{uuid}

Описание

Получение виджета

Параметры в запросе
Название Тип Описание
uuid* string

Тип ответа
Объединение
Возможные типы:
IntegrationWidget

boolean



PUT
/api/v3/integrationWidget/{widgetUUID}

Описание

Обновление виджета интеграцииМожно фильтровать по placeholder.

Параметры в запросе
Название Тип Описание
widgetUUID* string

Тело запроса
IntegrationWidget

Тип ответа
Объединение
Возможные типы:
IntegrationWidget

boolean



DELETE
/api/v3/integrationWidget/{widgetUUID}

Описание

Удаление виджета интеграцииМожно фильтровать по placeholder.

Параметры в запросе
Название Тип Описание
widgetUUID* string

Тип ответа
IntegrationWidget



POST
/api/v3/integrationWidget/{uuid}/enable

Описание

Включение виджета для текущего пользователя

Параметры в запросе
Название Тип Описание
uuid* string

Тип ответа
Объединение
Возможные типы:
IntegrationWidget

boolean



POST
/api/v3/integrationWidget/{uuid}/disable

Описание

Отключение виджета для текущего пользователя

Параметры в запросе
Название Тип Описание
uuid* string

Тип ответа
Объединение
Возможные типы:
IntegrationWidget

boolean




bums\invoice\api\v03\Entity\Consignment

18
Контроллер для работы с товарами

POST
/api/v3/consignment/{id}

Описание

Создание

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Consignment

Тип ответа
Consignment



DELETE
/api/v3/consignment/{id}

Описание

Удаление товара

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
void



GET
/api/v3/consignment/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Consignment



GET
/api/v3/consignment

Описание

Запрос на получение всех

Параметры в запросе
Название Тип Описание
q string

filter ConsignmentFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Consignment



GET
/api/v3/consignment/{id}/rows

Описание

Запрос на получение всех

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ConsignmentRow



GET
/api/v3/consignment/prepared

Описание

Отдает сущность накладной со сгенерированным номером

Тип ответа
Consignment



GET
/api/v3/consignment/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/consignment/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/consignment/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/consignment/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/consignment/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/consignment/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/consignment/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/consignment/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/consignment/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/consignment/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/consignment/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/consignment/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\invoice\api\v03\Entity\ConsignmentRow

4

POST
/api/v3/consignmentRow/{id}

Описание

Создание

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
ConsignmentRow

Тип ответа
ConsignmentRow



DELETE
/api/v3/consignmentRow/{id}

Описание

Удаление

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
void



GET
/api/v3/consignmentRow/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
ConsignmentRow



GET
/api/v3/consignmentRow

Описание

Запрос на получение всех

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ConsignmentRow




bums\invoice\api\v03\Entity\OfferCategory

4

GET
/api/v3/offerCategory/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
OfferCategory



GET
/api/v3/offerCategory

Параметры в запросе
Название Тип Описание
parent OfferCategory

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: OfferCategory



GET
/api/v3/offerCategory/{id}/fields

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/offerCategory/{id}/parents

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: OfferCategory




bums\invoice\api\v03\Entity\OfferImport

10

GET
/api/v3/offerImport

Описание

Получение списка сессий

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: OfferImport



GET
/api/v3/offerImport/{id}/incorrectDataRows

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сессии импорта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow



POST
/api/v3/offerImport

Описание

Создание новой сессииобязательны поля destination и file

Тело запроса
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport

Тип ответа
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport



POST
/api/v3/offerImport/{id}

Описание

Обновление сессии

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport

Тип ответа
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport



GET
/api/v3/offerImport/{id}

Описание

Возващает одну сессию импорта

Параметры в запросе
Название Тип Описание
id* integer

recalcColumns boolean

Тип ответа
Объединение
Возможные типы:
ContractorImport

FinOperationImport

OfferImport

EmployeeImport



DELETE
/api/v3/offerImport/{id}

Описание

Удаление сессии

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean



GET
/api/v3/offerImport/{id}/rows

Описание

Возващает строки импорта

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow



GET
/api/v3/offerImport/{id}/columns

Описание

Возващает колонки импорта

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportColumn



GET
/api/v3/offerImport/{id}/invalidatedRows

Описание

Возващает инвалидированные строки

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow



GET
/api/v3/offerImport/{id}/errorRows

Описание

Возващает инвалидированные строки + строки с ошибками

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ImportRow




bums\invoice\api\v03\Entity\OfferPart

2

POST
/api/v3/offerPart

Описание

Создание нового комплекта

Параметры в запросе
Название Тип Описание
id integer

Тело запроса
OfferPart

Тип ответа
OfferPart



DELETE
/api/v3/offerPart/{id}

Описание

Удаление комплекта

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
void




bums\invoice\api\v03\Entity\Warehouse

24

POST
/api/v3/warehouse/{id}

Описание

Создание

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Warehouse

Тип ответа
Warehouse



DELETE
/api/v3/warehouse/{id}

Описание

Удаление

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
void



GET
/api/v3/warehouse/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Warehouse



GET
/api/v3/warehouse

Описание

Запрос на получение всех

Параметры в запросе
Название Тип Описание
q string

filter WarehouseFilter

offer Offer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Warehouse



GET
/api/v3/warehouse/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/warehouse/{id}/deficitOffers

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

mode string

Как именно будем считать остатки (с резервированием или без)

contextEntity Объединение
Возможные типы:
Consignment

Deal

Offer

Откуда брать строки с товарами и необходимым количеством

deficitOffers Коллекция

Возможные типы: DeficitOffer

Если провайдер не передан, то можно передать прямо то, что надо проверить

quantityRatio integer

Тип ответа
Коллекция

Возможные типы: DeficitOffer



GET
/api/v3/warehouse/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/warehouse/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/warehouse/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/warehouse/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/warehouse/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/warehouse/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/warehouse/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/warehouse/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/warehouse/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/warehouse/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/warehouse/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/warehouse/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/warehouse/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/warehouse/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/warehouse/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction



GET
/api/v3/warehouse/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



GET
/api/v3/warehouse/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/warehouse/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File




bums\invoice\api\v03\Entity\WarehousePermission

5
Контроллер для работы с доступами по складу

POST
/api/v3/warehousePermission

Описание

Создание

Тело запроса
WarehousePermission

Тип ответа
WarehousePermission



POST
/api/v3/warehousePermission/{id}

Описание

Обновление

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
WarehousePermission

Тип ответа
WarehousePermission



DELETE
/api/v3/warehousePermission/{id}

Описание

Удаление

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
void



GET
/api/v3/warehousePermission/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
WarehousePermission



GET
/api/v3/warehousePermission

Описание

Запрос на получение всех

Параметры в запросе
Название Тип Описание
warehouse Warehouse

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: WarehousePermission




bums\invoice\api\v03\Entity\WarehouseType

2

GET
/api/v3/warehouseType/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
WarehouseType



GET
/api/v3/warehouseType

Описание

Запрос на получение всех

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: WarehouseType




bums\report\api\v03\Entity\Report

18
Контроллер для работы с отчетами

GET
/api/v3/report/{reportId}

Параметры в запросе
Название Тип Описание
reportId* integer

Тип ответа
Report



POST
/api/v3/report/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Report

Тип ответа
Report



GET
/api/v3/report/rights

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

Group



POST
/api/v3/report

Тело запроса
Report

Тип ответа
Report



GET
/api/v3/report/{id}/data

Описание

Данные по отчету (пока только группировки)

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
ReportChartData



GET
/api/v3/report/forDesktop

Описание

Возвращает список отчетов, доступных для отображения в виджете графиков на Рабочем столе

Параметры в запросе
Название Тип Описание
type string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Report



GET
/api/v3/report/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/report/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/report/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/report/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/report/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/report/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/report/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/report/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/report/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/report/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/report/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/report/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\settings\api\v03\Controller\Request\MobileOrderLead

1

POST
/api/v3/mobileOrderLead

Тело запроса
MobileOrderLead

Тип ответа
MobileOrderLead




bums\settings\api\v03\Entity\Account

9
Контроллер аккаунта. Служит для получения данных о лицензии и доступных продуктах

GET
/api/v3/account/account

Описание

Получение информации о аккаунте

Тип ответа
Account



DELETE
/api/v3/account

Тело запроса
AuthorizationRequest

Тип ответа
any



GET
/api/v3/account/referralId

Описание

Полчение идентификатора реферальной ссылки

Тип ответа
string



POST
/api/v3/account

Описание

Обновляет аккаунт (смена тарифа)

Тело запроса
Account

Тип ответа
Account



GET
/api/v3/account/asyncUpdatePrimaryUserInfo

Описание

Передача ФИ и телефона в админку и МУМУ

Тип ответа
void



POST
/api/v3/account/sendInterviewAsync

Описание

Передача данных опроса в админку и МУМУ

Тело запроса
InterviewResult

Тип ответа
void



GET
/api/v3/account/abCheckPhone/{phone}

Описание

Отправка смс-кода

Параметры в запросе
Название Тип Описание
phone* string

Тип ответа
boolean



GET
/api/v3/account/checkCode/{phone}/{smsCode}

Описание

Проверка смс-кода

Параметры в запросе
Название Тип Описание
phone* string

smsCode* string

Тип ответа
boolean



GET
/api/v3/account/personalAreaUri

Описание

Получение ссылки для входа в новый ЛК

Тип ответа
string




bums\settings\api\v03\Entity\AccountAutoPay

3
Контроллер для управления заказами аккаунта

GET
/api/v3/accountAutoPay

Описание

Получение списка автоплатежей

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: AccountAutoPay



DELETE
/api/v3/accountAutoPay/{id}

Описание

Перманентное удаление клиента

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean



POST
/api/v3/accountAutoPay/{id}

Описание

Активирование приостановленного автоплатежа

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
AccountAutoPay

Тип ответа
AccountAutoPay




bums\settings\api\v03\Entity\AccountDoc

1
Контроллер для управления закрывающими документами

GET
/api/v3/accountDoc

Описание

Получение списка автоплатежей

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: AccountDoc




bums\settings\api\v03\Entity\AccountOrder

8
Контроллер для управления заказами аккаунта

POST
/api/v3/accountOrder/calcPrice

Описание

Получение итоговой цены по переданным параметрам продукта

Тело запроса
AccountOrder

Тип ответа
AccountOrder



GET
/api/v3/accountOrder

Описание

Получение списка заказов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: AccountOrder



GET
/api/v3/accountOrder/telephony

Описание

Получение списка заказов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: AccountOrder



GET
/api/v3/accountOrder/{id}

Описание

Получение конкретного заказа

Параметры в запросе
Название Тип Описание
id* string

Идентификатор заказа

Тип ответа
AccountOrder



GET
/api/v3/accountOrder/new

Описание

Новый заказ

Тип ответа
AccountOrder



POST
/api/v3/accountOrder/{id}

Описание

Обновление заказа

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
AccountOrder

Тип ответа
AccountOrder



POST
/api/v3/accountOrder

Описание

Создание заказа

Тело запроса
AccountOrder

Тип ответа
AccountOrder



POST
/api/v3/accountOrder/payment/init

Описание

Получение итоговой цены по переданным параметрам продукта

Параметры в запросе
Название Тип Описание
payForm* string

enableAutoPay* boolean

Тело запроса
AccountOrder

Тип ответа
string




bums\settings\api\v03\Entity\EditionExceed

1
Контроллер управления пакетами объектов для бесплатных продуктов

GET
/api/v3/editionExceed/{object}

Описание

Получить набор пакетов для конкретного типа объектов

Параметры в запросе
Название Тип Описание
object* string

Тип ответа
EditionExceed




bums\settings\api\v03\Entity\ObjectPacket

2
Контроллер управления пакетами объектов для бесплатных продуктов

GET
/api/v3/objectPacket/{object}

Описание

Получить набор пакетов для конкретного типа объектов

Параметры в запросе
Название Тип Описание
object* string

Тип ответа
ObjectPacket



POST
/api/v3/objectPacket/createOrder

Описание

Создает заказ на новый пакет

Тело запроса
ObjectPacket

Тип ответа
string




bums\spaces\api\v03\Entity\FieldSettings

1
Общий контроллер полей таблиц для типов полей сущностей

GET
/api/v3/fieldSettings/{entity}

Параметры в запросе
Название Тип Описание
entity* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: any




bums\staff\api\v03\Entity\Bonus

3

POST
/api/v3/bonus

Тело запроса
Bonus

Тип ответа
Bonus



POST
/api/v3/bonus/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Bonus

Тип ответа
Bonus



DELETE
/api/v3/bonus/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean




bums\staff\api\v03\Entity\CanLoginEmployeesCountRestriction

1

GET
/api/v3/canLoginEmployeesCountRestriction

Тип ответа
CanLoginEmployeesCountRestriction




bums\staff\api\v03\Entity\Department

1

GET
/api/v3/department

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Department




bums\staff\api\v03\Entity\EmployeeStatus

1

GET
/api/v3/employeeStatus

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: EmployeeStatus




bums\staff\api\v03\Entity\InviteLink

7

GET
/api/v3/inviteLink

Описание

Получение списка ссылок-приглашений

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: InviteLink



GET
/api/v3/inviteLink/{id}

Описание

Получение конкретной ссылки-приглашеня

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
InviteLink



POST
/api/v3/inviteLink/{id}

Описание

Обновление ссылки-приглашения

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
InviteLink

Тип ответа
InviteLink



GET
/api/v3/inviteLink/{id}/employees

Описание

Получение сотрудников, зарегестрированных по ссылке

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
InviteLink



DELETE
/api/v3/inviteLink/{id}/employees/{employeeId}

Описание

Удаление сотрудников из списка

Параметры в запросе
Название Тип Описание
id* string

employeeId* string

Тип ответа
InviteLink



DELETE
/api/v3/inviteLink/{id}

Описание

Обновление ссылки-приглашения

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
boolean



POST
/api/v3/inviteLink/{id}/refreshUuid

Описание

Перегенерация uuid

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
InviteLink




bums\staff\api\v03\Entity\InviteLinkRegistration

2

GET
/api/v3/inviteLinkRegistration/testLink/{uuid}

Описание

Проверка доступности ссылки-приглашения

Параметры в запросе
Название Тип Описание
uuid* string

Тип ответа
boolean



POST
/api/v3/inviteLinkRegistration

Описание

Создание нового пользователя по ссылке-приглашению

Тело запроса
InviteLinkRegistration

Тип ответа
Variable




bums\staff\api\v03\Entity\InvitedEmployee

2
Контроллер для работы с массовым созданием/приглашением сотрудников

GET
/api/v3/invitedEmployee

Описание

Получаем информацию о сотруднках в процессе создания/приглашения

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: InvitedEmployee



POST
/api/v3/invitedEmployee

Описание

Массовое создание/приглашение сотрудников

Тело запроса
Коллекция

Возможные типы: InvitedEmployee

Тип ответа
Коллекция

Возможные типы: InvitedEmployee




bums\staff\api\v03\Entity\Position

1

GET
/api/v3/position

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Position




bums\staff\api\v03\Entity\Vacation

1

POST
/api/v3/vacation/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
Vacation

Тип ответа
Vacation




bums\task\project\api\v03\Entity\Project

88
Контроллер для работы с проектами

POST
/api/v3/project

Описание

Создание проекта

Тело запроса
Project

Тип ответа
Project



GET
/api/v3/project

Описание

Получение списка проектов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Project



POST
/api/v3/project/{id}

Описание

Обновление проекта

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

Тело запроса
Project

Тип ответа
Project



GET
/api/v3/project/{id}

Описание

Получение отдельного проекта

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

Тип ответа
Project



DELETE
/api/v3/project/{id}

Описание

Удаление проекта

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

Тип ответа
Project



GET
/api/v3/project/{id}/availableParents

Описание

Поиск возможных вариантов для надзадачи/надпроекта

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

isTemplate boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Project



GET
/api/v3/project/availableParents

Описание

Поиск возможных вариантов для надзадачи/надпроекта

Параметры в запросе
Название Тип Описание
isTemplate boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Project



GET
/api/v3/project/{id}/workedOffTime

Описание

Возвращает отработанное время

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Comment



GET
/api/v3/project/{entityId}/issues

Описание

Задачи проекта

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор проекта

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/project/{entityId}/actualIssues

Описание

Получение актуальных задач проекта

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор проекта

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



POST
/api/v3/project/{id}/doAction

Описание

Действие над проектом

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

Тело запроса
ProjectActionRequest

Тип ответа
Task



GET
/api/v3/project/{id}/finOperations

Описание

Получить финансовые операции

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: FinOperation



GET
/api/v3/project/{id}/deals

Описание

Получить сделки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/project/{id}/deals/extraFields

Описание

Возвращает дополнительные поля программы

Параметры в запросе
Название Тип Описание
id* integer

Неиспользуемый идентификатор

fieldNames Коллекция

Возможные типы: string

Массив названий запрашиваемых полей

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/project/{id}/delegationTargets

Описание

Коллекция возможных делегатов для задачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman



GET
/api/v3/project/templates

Описание

Возвращает шаблоны проектов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Project



GET
/api/v3/project/{id}/groups

Описание

Возвращает группы в которых содержится проект

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор проекта

withFixedFilters boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TaskFilter



GET
/api/v3/project/{projectId}/commentTransportEmailTo

Описание

Список почт которым можно отправить комментарий

Параметры в запросе
Название Тип Описание
projectId* integer

Идентификатор проекта

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContactInfo



POST
/api/v3/project/{projectId}/convert

Описание

Конвертирование проекта в задачу

Параметры в запросе
Название Тип Описание
projectId* integer

Тип ответа
Task



GET
/api/v3/project/{id}/auditors

Описание

Получение аудиторов

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/project/{id}/auditors

Описание

Добавление аудитора

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
Group

ContractorCompany

ContractorHuman

Employee

BaseEntity

Тип ответа
Объединение
Возможные типы:
Task

Project



DELETE
/api/v3/project/{id}/auditors/{auditorContentType}/{auditorId}

Описание

Удаление аудитора

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

auditorContentType* string

contentType аудитора

auditorId* integer

Идентификатор аудитора

Тип ответа
Объединение
Возможные типы:
Task

Project



GET
/api/v3/project/{id}/executors

Описание

Получение соисполнителей

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/project/{id}/executors

Описание

Добавление соисполнителя

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Тип ответа
Объединение
Возможные типы:
Task

Project



DELETE
/api/v3/project/{id}/executors/{executorContentType}/{executorId}

Описание

Удаление соисполнителя

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

executorContentType* string

contentType соисполнителя

executorId* integer

Идентификатор соисполнителя

Тип ответа
Объединение
Возможные типы:
Task

Project



GET
/api/v3/project/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/project/{id}/changeDeadline

Описание

Сдвиг дедлайна для тех кто может

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
DeadlineChangeRequest

Тип ответа
Коллекция

Возможные типы: Project



GET
/api/v3/project/{id}/ownerTargets

Описание

Возможные постановщики для задачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/project/availableParticipants

Описание

Список сотрудников и физических лиц, которые могут быть выбраны в качестве ответственных, исполнителей или аудиторов

Параметры в запросе
Название Тип Описание
superTask Объединение
Возможные типы:
Task

Project

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

Group



GET
/api/v3/project/availableResponsibles

Описание

Получение списка доступных ответственных

Параметры в запросе
Название Тип Описание
superTask Объединение
Возможные типы:
Task

Project

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman



GET
/api/v3/project/{id}/milestones

Описание

Возвращает вехи привязанные к задаче/проекту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Milestone



POST
/api/v3/project/{id}/milestones

Описание

Добавляет вехи к задаче/проекту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Milestone

Тип ответа
Milestone



GET
/api/v3/project/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/project/{id}/allParticipants

Описание

Получение всех текущих участников задачи и проектов

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/project/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/project/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/project/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo



GET
/api/v3/project/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



POST
/api/v3/project/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/project/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/project/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/project/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/project/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/project/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/project/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/project/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/project/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/project/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



POST
/api/v3/project/{entityId}/relationLinks/{id}

Описание

Добавление/обновление ссылок

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор ссылки

Тело запроса
RelationLink

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/project/{entityId}/relationLinks

Описание

Получение списка связей для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/project/{entityId}/relationLinks/{id}

Описание

Получение связи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор связи

Тип ответа
RelationLink



DELETE
/api/v3/project/{entityId}/relationLinks/{id}

Описание

Удаление связной ссылки

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор сущности

id* integer

Идентификатор ссылки

Тип ответа
boolean



GET
/api/v3/project/{id}/links

Описание

Все связанные ссылки задачи и ее комментариев

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/project/tags

Описание

Получить варианты тегов для сущности

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/project/tags/{id}

Описание

Создание/обновление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тело запроса
Tag

Тип ответа
Tag



DELETE
/api/v3/project/tags/{id}

Описание

Удаление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тип ответа
Tag



GET
/api/v3/project/{entityId}/tags

Описание

Получить все привязанные теги для конкретной сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



DELETE
/api/v3/project/{entityId}/tags/{tagId}

Описание

Отвязать тег от сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

tagId* integer

Идентификатор тега

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/project/{id}/tags

Описание

Добавление тегов сущности.Метку может добавлять любой сотрудник к любой сущности к которой у него есть доступ.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Tag

Тип ответа
BaseEntity



GET
/api/v3/project/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/project/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/project/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/project/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/project/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/project/{entityId}/templateUsers

Описание

Шаблоны, где сотрудник входит в число пользователей с полным доступом к шаблону

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/project/{entityId}/templateViewers

Описание

Шаблоны, где сотрудник входит в пользователей,которые могут просматривать и использовать шаблон

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/project/{entityId}/templateUsers

Описание

Добавление сотрудника в число пользователей шаблона с полным доступом

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/project/{entityId}/templateViewers

Описание

Добавление сотрудника в число пользователей шаблона

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



DELETE
/api/v3/project/{entityId}/templateUsers/{templateUserContentType}/{templateUserId}

Описание

Удаление сотрудника из числа пользователей шаблона с полным доступом

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

templateUserContentType* string

contentType шаблона сотрудника

templateUserId* integer

Идентификатор шаблона сотрудника

Тип ответа
BaseEntity



DELETE
/api/v3/project/{entityId}/templateViewers/{templateViewerContentType}/{templateViewerId}

Описание

Удаление сотрудника из числа пользователей шаблона

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

templateViewerContentType* string

contentType шаблона сотрудника

templateViewerId* integer

Идентификатор сотрудника

Тип ответа
BaseEntity



POST
/api/v3/project/{entityId}/schedule

Описание

Создание или обновление события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Schedule

Тип ответа
BaseEntity



DELETE
/api/v3/project/{entityId}/schedule

Описание

Удаление события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
BaseEntity



GET
/api/v3/project/{entityId}/entitiesByTemplate

Описание

Получение сущностей по шаблону

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/project/{entityId}/actualEntitiesByTemplate

Описание

Отдаёт все актуальные подзадачи переданной задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/project/{entityId}/preparedTemplate

Описание

Отдаёт все подготовленные подзадачи переданной задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
any



POST
/api/v3/project/{id}/createTemplate

Описание

Создание шаблона для сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тип ответа
Объединение
Возможные типы:
Task

Project



POST
/api/v3/project/{entityId}/clone

Описание

Клонирование шаблона

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
any



GET
/api/v3/project/templateVariables

Описание

Возвращает пременные шаблона

Параметры в запросе
Название Тип Описание
onlyForFileName boolean

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/project/{id}/docTemplates

Описание

Отдаёт шаблоны документов сущности (контрагент, задача, проект, сделка)

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



GET
/api/v3/project/{id}/templateFields/{templateId}

Описание

Отдаёт переменные из шаблона заполненные данными по клиенту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

templateId* integer

Идентификатор шаблона

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Variable



POST
/api/v3/project/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/project/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/project/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/project/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/project/{id}/reminder

Описание

Обновление напоминания

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
ReminderTimeRequest

Тип ответа
BaseEntity



GET
/api/v3/project/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/project/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/project/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\task\task\api\v03\Entity\DeadlineChangeRequest

1
Контроллер для работы с вехами

POST
/api/v3/deadlineChangeRequest/{id}

Описание

Обновление запроса

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
DeadlineChangeRequest

Тип ответа
Task




bums\task\task\api\v03\Entity\Milestone

4
Контроллер для работы с вехами

POST
/api/v3/milestone

Описание

Создание новой вехи

Тело запроса
Milestone

Тип ответа
Milestone



POST
/api/v3/milestone/{id}

Описание

Обновление вехи

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Milestone

Тип ответа
Milestone



DELETE
/api/v3/milestone/{id}

Описание

Удаление вехи

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
BaseEntity



GET
/api/v3/milestone/reminderTransports

Описание

Возможные транспорты для напоминаний

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: string




bums\task\task\api\v03\Entity\NegotiationItem

1

DELETE
/api/v3/negotiationItem/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean




bums\task\task\api\v03\Entity\NegotiationItemVersion

1

POST
/api/v3/negotiationItemVersion/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
NegotiationItemVersion

Тип ответа
NegotiationItemVersion




bums\task\task\api\v03\Entity\Task

97
Контроллер для работы с задачами

GET
/api/v3/task

Описание

Получение списка задачМожно фильтровать по placeholder

Параметры в запросе
Название Тип Описание
filter TaskFilter

Идентификатор или конфиг фильтра, по которому надо отфильтровать список задач

q string

statuses Коллекция

Возможные типы: string

Статусы задач, по которым нужно дополнительно отфильтровать список задач

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/task/treeLevel

Описание

Возвращает фильтрованный список проектов или задач текщуего уровня

Параметры в запросе
Название Тип Описание
filter TaskFilter

Идентификатор или конфиг фильтра, по которому надо отфильтровать всё дерево задач

parent Объединение
Возможные типы:
Task

Project

TreeNode

Родитель текущего уровня. null - для нулевого уровня

q string

filterHash string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/task/{id}

Описание

Получение отдельной задачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

Тип ответа
Task



GET
/api/v3/task/{entityId}/subTasks

Описание

Отдаёт все подзадачи переданной задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/task/{entityId}/actualSubTasks

Описание

Отдаёт все актуальные подзадачи переданной задачи.

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



POST
/api/v3/task

Описание

Добавление задачи

Тело запроса
Task

Тип ответа
Task



POST
/api/v3/task/{id}

Описание

Обновление задачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

Тело запроса
Task

Тип ответа
Task



DELETE
/api/v3/task/{id}

Описание

Удаление задачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

Тип ответа
Task



GET
/api/v3/task/{id}/delegationTargets

Описание

Коллекция возможных делегатов для задачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman



POST
/api/v3/task/{id}/doAction

Описание

Действие над задачей

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

Тело запроса
TaskActionRequest

Тип ответа
Task



GET
/api/v3/task/{id}/workedOffTime

Описание

Возвращает отработанное время

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Comment



GET
/api/v3/task/{id}/finOperations

Описание

Получить финансовые операции

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: FinOperation



GET
/api/v3/task/{id}/availableParents

Описание

Поиск возможных вариантов для надзадачи/надпроекта

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

isTemplate boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/task/availableParents

Описание

Поиск возможных вариантов для надзадачи/надпроекта

Параметры в запросе
Название Тип Описание
isTemplate boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



POST
/api/v3/task/{id}/bonus

Описание

Добавить бонусы к задаче

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

Тело запроса
Bonus

Тип ответа
Bonus



POST
/api/v3/task/{id}/delegate

Описание

Делегирует задачу другому сотруднику.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

Тело запроса
Employee

Тип ответа
Task



GET
/api/v3/task/{id}/templatePreviousTasks

Описание

Возвращает шаблоны надзадач

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Task



GET
/api/v3/task/templates

Описание

Возвращает шаблоны задач

Параметры в запросе
Название Тип Описание
negotiationOnly boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Task



GET
/api/v3/task/{id}/availablePreviousTasks

Описание

Возвращает надзадачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Task



GET
/api/v3/task/{id}/deals

Описание

Получить сделки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/task/{id}/deals/extraFields

Описание

Возвращает дополнительные поля программы

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

fieldNames Коллекция

Возможные типы: string

Массив названий запрашиваемых полей

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/task/{id}/groups

Описание

Возвращает группы в которых содержится задача

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

withFixedFilters boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: TaskFilter



GET
/api/v3/task/{taskId}/commentTransportEmailTo

Описание

Список почт которым можно отправить комментарий

Параметры в запросе
Название Тип Описание
taskId* integer

Идентификатор задачи

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContactInfo



GET
/api/v3/task/topResponsibles

Описание

Отдаёт популярных ответственных

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/task/topRoles/{fieldName}

Описание

Отдаёт популярных участников задачи

Параметры в запросе
Название Тип Описание
fieldName* string

Поле

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/task/{taskId}/negotiationItems

Описание

Возвращает элементы задачи-согласования

Параметры в запросе
Название Тип Описание
taskId* integer

Идентификатор задачи

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: NegotiationItem



POST
/api/v3/task/{taskId}/negotiationItems

Параметры в запросе
Название Тип Описание
taskId* integer

Идентификатор задачи

Тело запроса
NegotiationItem

Тип ответа
NegotiationItem



POST
/api/v3/task/{taskId}/convert

Описание

Конвертирование задачи в проект

Параметры в запросе
Название Тип Описание
taskId* integer

Тип ответа
Project



GET
/api/v3/task/{id}/auditors

Описание

Получение аудиторов

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/task/{id}/auditors

Описание

Добавление аудитора

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
Group

ContractorCompany

ContractorHuman

Employee

BaseEntity

Тип ответа
Объединение
Возможные типы:
Task

Project



DELETE
/api/v3/task/{id}/auditors/{auditorContentType}/{auditorId}

Описание

Удаление аудитора

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

auditorContentType* string

contentType аудитора

auditorId* integer

Идентификатор аудитора

Тип ответа
Объединение
Возможные типы:
Task

Project



GET
/api/v3/task/{id}/executors

Описание

Получение соисполнителей

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/task/{id}/executors

Описание

Добавление соисполнителя

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Тип ответа
Объединение
Возможные типы:
Task

Project



DELETE
/api/v3/task/{id}/executors/{executorContentType}/{executorId}

Описание

Удаление соисполнителя

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

executorContentType* string

contentType соисполнителя

executorId* integer

Идентификатор соисполнителя

Тип ответа
Объединение
Возможные типы:
Task

Project



GET
/api/v3/task/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/task/{id}/changeDeadline

Описание

Сдвиг дедлайна для тех кто может

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
DeadlineChangeRequest

Тип ответа
Коллекция

Возможные типы: Project



GET
/api/v3/task/{id}/ownerTargets

Описание

Возможные постановщики для задачи

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/task/availableParticipants

Описание

Список сотрудников и физических лиц, которые могут быть выбраны в качестве ответственных, исполнителей или аудиторов

Параметры в запросе
Название Тип Описание
superTask Объединение
Возможные типы:
Task

Project

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman

Group



GET
/api/v3/task/availableResponsibles

Описание

Получение списка доступных ответственных

Параметры в запросе
Название Тип Описание
superTask Объединение
Возможные типы:
Task

Project

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman



GET
/api/v3/task/{id}/milestones

Описание

Возвращает вехи привязанные к задаче/проекту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Milestone



POST
/api/v3/task/{id}/milestones

Описание

Добавляет вехи к задаче/проекту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Milestone

Тип ответа
Milestone



GET
/api/v3/task/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/task/{id}/allParticipants

Описание

Получение всех текущих участников задачи и проектов

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/task/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/task/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/task/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo



GET
/api/v3/task/{entityId}/templateUsers

Описание

Шаблоны, где сотрудник входит в число пользователей с полным доступом к шаблону

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/task/{entityId}/templateViewers

Описание

Шаблоны, где сотрудник входит в пользователей,которые могут просматривать и использовать шаблон

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/task/{entityId}/templateUsers

Описание

Добавление сотрудника в число пользователей шаблона с полным доступом

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/task/{entityId}/templateViewers

Описание

Добавление сотрудника в число пользователей шаблона

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



DELETE
/api/v3/task/{entityId}/templateUsers/{templateUserContentType}/{templateUserId}

Описание

Удаление сотрудника из числа пользователей шаблона с полным доступом

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

templateUserContentType* string

contentType шаблона сотрудника

templateUserId* integer

Идентификатор шаблона сотрудника

Тип ответа
BaseEntity



DELETE
/api/v3/task/{entityId}/templateViewers/{templateViewerContentType}/{templateViewerId}

Описание

Удаление сотрудника из числа пользователей шаблона

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

templateViewerContentType* string

contentType шаблона сотрудника

templateViewerId* integer

Идентификатор сотрудника

Тип ответа
BaseEntity



POST
/api/v3/task/{entityId}/schedule

Описание

Создание или обновление события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Schedule

Тип ответа
BaseEntity



DELETE
/api/v3/task/{entityId}/schedule

Описание

Удаление события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
BaseEntity



GET
/api/v3/task/{entityId}/entitiesByTemplate

Описание

Получение сущностей по шаблону

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/task/{entityId}/actualEntitiesByTemplate

Описание

Отдаёт все актуальные подзадачи переданной задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/task/{entityId}/preparedTemplate

Описание

Отдаёт все подготовленные подзадачи переданной задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
any



POST
/api/v3/task/{id}/createTemplate

Описание

Создание шаблона для сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тип ответа
Объединение
Возможные типы:
Task

Project



POST
/api/v3/task/{entityId}/clone

Описание

Клонирование шаблона

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
any



GET
/api/v3/task/templateVariables

Описание

Возвращает пременные шаблона

Параметры в запросе
Название Тип Описание
onlyForFileName boolean

Тип ответа
Коллекция

Возможные типы: Variable



POST
/api/v3/task/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/task/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/task/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/task/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/task/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/task/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/task/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/task/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/task/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/task/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/task/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



POST
/api/v3/task/{entityId}/relationLinks/{id}

Описание

Добавление/обновление ссылок

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор ссылки

Тело запроса
RelationLink

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/task/{entityId}/relationLinks

Описание

Получение списка связей для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/task/{entityId}/relationLinks/{id}

Описание

Получение связи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор связи

Тип ответа
RelationLink



DELETE
/api/v3/task/{entityId}/relationLinks/{id}

Описание

Удаление связной ссылки

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор сущности

id* integer

Идентификатор ссылки

Тип ответа
boolean



GET
/api/v3/task/{id}/links

Описание

Все связанные ссылки задачи и ее комментариев

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/task/tags

Описание

Получить варианты тегов для сущности

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/task/tags/{id}

Описание

Создание/обновление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тело запроса
Tag

Тип ответа
Tag



DELETE
/api/v3/task/tags/{id}

Описание

Удаление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тип ответа
Tag



GET
/api/v3/task/{entityId}/tags

Описание

Получить все привязанные теги для конкретной сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



DELETE
/api/v3/task/{entityId}/tags/{tagId}

Описание

Отвязать тег от сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

tagId* integer

Идентификатор тега

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/task/{id}/tags

Описание

Добавление тегов сущности.Метку может добавлять любой сотрудник к любой сущности к которой у него есть доступ.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Tag

Тип ответа
BaseEntity



GET
/api/v3/task/{id}/docTemplates

Описание

Отдаёт шаблоны документов сущности (контрагент, задача, проект, сделка)

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



GET
/api/v3/task/{id}/templateFields/{templateId}

Описание

Отдаёт переменные из шаблона заполненные данными по клиенту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

templateId* integer

Идентификатор шаблона

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/task/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/task/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/task/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/task/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/task/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/task/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/task/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/task/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/task/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/task/{id}/reminder

Описание

Обновление напоминания

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
ReminderTimeRequest

Тип ответа
BaseEntity



GET
/api/v3/task/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/task/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/task/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




bums\trade\api\v03\Entity\DealAspectDelivery

2
Контроллер для работы с доставкой

POST
/api/v3/dealAspectDelivery

Тело запроса
DealAspectDelivery

Тип ответа
DealAspectDelivery



POST
/api/v3/dealAspectDelivery/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
DealAspectDelivery

Тип ответа
DealAspectDelivery




bums\trade\api\v03\Entity\DeliveryType

1
Контроллер для получения списка типов доставки

GET
/api/v3/deliveryType

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DeliveryType




bums\trade\api\v03\Entity\PayForm

1
Контроллер для работы формами оплаты

GET
/api/v3/payForm

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: PayForm




logic\stm\api\v03\Entity\ProgramGroup

2

GET
/api/v3/programGroup/{id}

Описание

Получить схему сделки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
ProgramGroup



GET
/api/v3/programGroup/{id}/programs

Описание

Получить программу по полю slug

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Program




logic\stm\api\v03\Entity\ProgramPluralForm

4

GET
/api/v3/programPluralForm

Тип ответа
ProgramPluralForm



GET
/api/v3/programPluralForm/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
ProgramPluralForm



POST
/api/v3/programPluralForm

Параметры в запросе
Название Тип Описание
id string

Тело запроса
ProgramPluralForm

Тип ответа
ProgramPluralForm



DELETE
/api/v3/programPluralForm/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean




logic\stm\api\v03\Entity\ProgramPreset

2
Контроллер для работы со пресетами

GET
/api/v3/programPreset

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: any



GET
/api/v3/programPreset/addPreset

Описание

Добавление программы из пресета

Параметры в запросе
Название Тип Описание
presetAlias* string

Тип ответа
string




logic\stm\api\v03\Entity\TriggerLogSet

1

GET
/api/v3/triggerLogSet/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
TriggerLogSet




Валюта

1
Контроллер для работы с валютами

GET
/api/v3/currency

Описание

Список возможных валют

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Currency




Единица измерений

1
Контроллер для работы с единицами измерений товаров

GET
/api/v3/unit

Описание

Список возможных единиц измерений товаров

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Unit




Информация об аккаунте

1
Контроллер информации о версии, названии и идентификаторе аккаунта.

GET
/api/v3/accountInfo

Описание

Получение информации о версии, названии и идентификаторе аккаунта

Тип ответа
AccountInfo




Клиент

61
Контроллер для работы с клиентами

GET
/api/v3/contractor

Описание

Получение списка клиентов

Параметры в запросе
Название Тип Описание
filter CrmFilter

q string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractor/{id}

Описание

Получение отдельного клиента

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractor/types

Описание

Отдаёт типы клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorType



GET
/api/v3/contractor/{id}/possibleDuplicates

Описание

Отдаёт возможных дублёров

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractor/possibleDuplicates

Описание

Отдаёт возможных дублёров клиента на основе реквеста

Параметры в запросе
Название Тип Описание
name string

contactInfo Коллекция

Возможные типы: ContactInfo

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractor/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/contractor/{id}/responsibles

Описание

Добавление ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

Тело запроса
Объединение
Возможные типы:
Employee

ContractorHuman

Тип ответа
boolean



DELETE
/api/v3/contractor/{id}/responsibles/{responsibleContentType}/{responsibleId}

Описание

Удаление ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

responsibleContentType* string

contentType ответственного

responsibleId* integer

Идентификатор ответственного

Тип ответа
boolean



GET
/api/v3/contractor/addressTypes

Описание

Отдаёт типы адресов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: AddressType



POST
/api/v3/contractor/{id}/merge

Описание

Объединение контрагентов.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



POST
/api/v3/contractor/{id}/similar

Описание

Помечаем как "похожие"

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Тип ответа
boolean



GET
/api/v3/contractor/{id}/similar

Описание

Отдаёт помеченных как "похожие"

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractor/{entityId}/tasks

Описание

Отдаёт все задачи переданного клиента

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор контрагента

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/contractor/{entityId}/actualTasks

Описание

Отдаёт все актуальные подзадачи переданной задачи.

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор контрагента

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/contractor/{id}/deals

Описание

Получить cделки

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/contractor/{entityId}/deals/extraFields

Описание

Получение расширенных полей сделки

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор контрагента

fieldNames Коллекция

Возможные типы: string

Массив названий запрашиваемых полей

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/contractor/{id}/groups

Описание

Возвращает группы в которых содержится контрагент

Параметры в запросе
Название Тип Описание
id* string

Идентификатор сущности

withFixedFilters boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CrmFilter



DELETE
/api/v3/contractor/{id}

Описание

Перманентное удаление клиента

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
DeleteActionRequest

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractor/{id}/invoices

Описание

Список счетов по контрагенту

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Invoice



POST
/api/v3/contractor/{id}/payers

Описание

Создание нового плательщика

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

Тело запроса
Payer

Тип ответа
Payer



GET
/api/v3/contractor/{id}/payers

Описание

Список плательщиков клиента

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Payer



GET
/api/v3/contractor/{id}/commentTransportEmailTo

Описание

Список почтовых адресов которым можно отправить комментарий

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContactInfo



GET
/api/v3/contractor/initialCreatedOwnCompany

Описание

Возвращает исходный идентификатор компании "Наша компания"

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractor/{id}/contacts

Описание

Список контактов по контрагенту

Параметры в запросе
Название Тип Описание
id* string

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractor/{id}/allParticipants

Описание

Получение всех текущих участников клиента

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/contractor/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/contractor/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/contractor/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/contractor/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/contractor/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/contractor/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/contractor/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/contractor/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/contractor/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/contractor/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/contractor/tags

Описание

Получить варианты тегов для сущности

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/contractor/tags/{id}

Описание

Создание/обновление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тело запроса
Tag

Тип ответа
Tag



DELETE
/api/v3/contractor/tags/{id}

Описание

Удаление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тип ответа
Tag



GET
/api/v3/contractor/{entityId}/tags

Описание

Получить все привязанные теги для конкретной сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



DELETE
/api/v3/contractor/{entityId}/tags/{tagId}

Описание

Отвязать тег от сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

tagId* integer

Идентификатор тега

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/contractor/{id}/tags

Описание

Добавление тегов сущности.Метку может добавлять любой сотрудник к любой сущности к которой у него есть доступ.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Tag

Тип ответа
BaseEntity



GET
/api/v3/contractor/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



POST
/api/v3/contractor/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/contractor/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/contractor/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/contractor/{entityId}/relationLinks/{id}

Описание

Добавление/обновление ссылок

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор ссылки

Тело запроса
RelationLink

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractor/{entityId}/relationLinks

Описание

Получение списка связей для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractor/{entityId}/relationLinks/{id}

Описание

Получение связи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор связи

Тип ответа
RelationLink



DELETE
/api/v3/contractor/{entityId}/relationLinks/{id}

Описание

Удаление связной ссылки

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор сущности

id* integer

Идентификатор ссылки

Тип ответа
boolean



GET
/api/v3/contractor/{id}/links

Описание

Все связанные ссылки задачи и ее комментариев

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractor/{id}/docTemplates

Описание

Отдаёт шаблоны документов сущности (контрагент, задача, проект, сделка)

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



GET
/api/v3/contractor/{id}/templateFields/{templateId}

Описание

Отдаёт переменные из шаблона заполненные данными по клиенту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

templateId* integer

Идентификатор шаблона

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/contractor/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/contractor/{id}/reminder

Описание

Обновление напоминания

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
ReminderTimeRequest

Тип ответа
BaseEntity



GET
/api/v3/contractor/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/contractor/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



POST
/api/v3/contractor/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/contractor/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/contractor/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/contractor/templateVariables

Описание

Возвращает пременные шаблона

Параметры в запросе
Название Тип Описание
onlyForFileName boolean

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/contractor/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




Клиент-компания

69
Контроллер для работы с клиентами-компаниями

GET
/api/v3/contractorCompany

Описание

Возвращает клиенты-компании

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorCompany



POST
/api/v3/contractorCompany

Описание

Создать нового клиента

Тело запроса
ContractorCompany

Тип ответа
ContractorCompany



POST
/api/v3/contractorCompany/{id}

Описание

Обновление клиента

Параметры в запросе
Название Тип Описание
id* string

Идентификатор клиента-компании

Тело запроса
ContractorCompany

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/contractorCompany

Описание

Получение списка клиентов

Параметры в запросе
Название Тип Описание
filter CrmFilter

q string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/{id}

Описание

Получение отдельного клиента

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/types

Описание

Отдаёт типы клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorType



GET
/api/v3/contractorCompany/{id}/possibleDuplicates

Описание

Отдаёт возможных дублёров

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/possibleDuplicates

Описание

Отдаёт возможных дублёров клиента на основе реквеста

Параметры в запросе
Название Тип Описание
name string

contactInfo Коллекция

Возможные типы: ContactInfo

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/contractorCompany/{id}/responsibles

Описание

Добавление ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

Тело запроса
Объединение
Возможные типы:
Employee

ContractorHuman

Тип ответа
boolean



DELETE
/api/v3/contractorCompany/{id}/responsibles/{responsibleContentType}/{responsibleId}

Описание

Удаление ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

responsibleContentType* string

contentType ответственного

responsibleId* integer

Идентификатор ответственного

Тип ответа
boolean



GET
/api/v3/contractorCompany/addressTypes

Описание

Отдаёт типы адресов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: AddressType



POST
/api/v3/contractorCompany/{id}/merge

Описание

Объединение контрагентов.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



POST
/api/v3/contractorCompany/{id}/similar

Описание

Помечаем как "похожие"

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Тип ответа
boolean



GET
/api/v3/contractorCompany/{id}/similar

Описание

Отдаёт помеченных как "похожие"

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/{entityId}/tasks

Описание

Отдаёт все задачи переданного клиента

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор контрагента

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/contractorCompany/{entityId}/actualTasks

Описание

Отдаёт все актуальные подзадачи переданной задачи.

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор контрагента

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/contractorCompany/{id}/deals

Описание

Получить cделки

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/contractorCompany/{entityId}/deals/extraFields

Описание

Получение расширенных полей сделки

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор контрагента

fieldNames Коллекция

Возможные типы: string

Массив названий запрашиваемых полей

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/contractorCompany/{id}/groups

Описание

Возвращает группы в которых содержится контрагент

Параметры в запросе
Название Тип Описание
id* string

Идентификатор сущности

withFixedFilters boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CrmFilter



DELETE
/api/v3/contractorCompany/{id}

Описание

Перманентное удаление клиента

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
DeleteActionRequest

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/{id}/invoices

Описание

Список счетов по контрагенту

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Invoice



POST
/api/v3/contractorCompany/{id}/payers

Описание

Создание нового плательщика

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

Тело запроса
Payer

Тип ответа
Payer



GET
/api/v3/contractorCompany/{id}/payers

Описание

Список плательщиков клиента

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Payer



GET
/api/v3/contractorCompany/{id}/commentTransportEmailTo

Описание

Список почтовых адресов которым можно отправить комментарий

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContactInfo



GET
/api/v3/contractorCompany/initialCreatedOwnCompany

Описание

Возвращает исходный идентификатор компании "Наша компания"

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/{id}/contacts

Описание

Список контактов по контрагенту

Параметры в запросе
Название Тип Описание
id* string

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorCompany/{id}/allParticipants

Описание

Получение всех текущих участников клиента

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/contractorCompany/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/contractorCompany/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/contractorCompany/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/contractorCompany/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/contractorCompany/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/contractorCompany/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/contractorCompany/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/contractorCompany/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/contractorCompany/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/contractorCompany/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/contractorCompany/tags

Описание

Получить варианты тегов для сущности

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/contractorCompany/tags/{id}

Описание

Создание/обновление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тело запроса
Tag

Тип ответа
Tag



DELETE
/api/v3/contractorCompany/tags/{id}

Описание

Удаление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тип ответа
Tag



GET
/api/v3/contractorCompany/{entityId}/tags

Описание

Получить все привязанные теги для конкретной сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



DELETE
/api/v3/contractorCompany/{entityId}/tags/{tagId}

Описание

Отвязать тег от сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

tagId* integer

Идентификатор тега

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/contractorCompany/{id}/tags

Описание

Добавление тегов сущности.Метку может добавлять любой сотрудник к любой сущности к которой у него есть доступ.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Tag

Тип ответа
BaseEntity



GET
/api/v3/contractorCompany/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



POST
/api/v3/contractorCompany/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/contractorCompany/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/contractorCompany/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/contractorCompany/{entityId}/relationLinks/{id}

Описание

Добавление/обновление ссылок

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор ссылки

Тело запроса
RelationLink

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractorCompany/{entityId}/relationLinks

Описание

Получение списка связей для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractorCompany/{entityId}/relationLinks/{id}

Описание

Получение связи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор связи

Тип ответа
RelationLink



DELETE
/api/v3/contractorCompany/{entityId}/relationLinks/{id}

Описание

Удаление связной ссылки

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор сущности

id* integer

Идентификатор ссылки

Тип ответа
boolean



GET
/api/v3/contractorCompany/{id}/links

Описание

Все связанные ссылки задачи и ее комментариев

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractorCompany/{id}/docTemplates

Описание

Отдаёт шаблоны документов сущности (контрагент, задача, проект, сделка)

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



GET
/api/v3/contractorCompany/{id}/templateFields/{templateId}

Описание

Отдаёт переменные из шаблона заполненные данными по клиенту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

templateId* integer

Идентификатор шаблона

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/contractorCompany/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/contractorCompany/{id}/reminder

Описание

Обновление напоминания

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
ReminderTimeRequest

Тип ответа
BaseEntity



GET
/api/v3/contractorCompany/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/contractorCompany/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



POST
/api/v3/contractorCompany/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/contractorCompany/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/contractorCompany/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/contractorCompany/templateVariables

Описание

Возвращает пременные шаблона

Параметры в запросе
Название Тип Описание
onlyForFileName boolean

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/contractorCompany/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction



GET
/api/v3/contractorCompany/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/contractorCompany/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/contractorCompany/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/contractorCompany/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField




Клиент-человек

70
Контроллер для работы с клиентами-физическими лицами

GET
/api/v3/contractorHuman

Описание

Получение клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorHuman



GET
/api/v3/contractorHuman/guests

Описание

Получение списка клиентов с гостевым доступом

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorHuman



POST
/api/v3/contractorHuman

Описание

Создать нового клиента

Тело запроса
ContractorHuman

Тип ответа
ContractorHuman



POST
/api/v3/contractorHuman/{id}

Описание

Обновление клиента

Параметры в запросе
Название Тип Описание
id* string

Идентификатор клиента

Тело запроса
ContractorHuman

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/contractorHuman

Описание

Получение списка клиентов

Параметры в запросе
Название Тип Описание
filter CrmFilter

q string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/{id}

Описание

Получение отдельного клиента

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/types

Описание

Отдаёт типы клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorType



GET
/api/v3/contractorHuman/{id}/possibleDuplicates

Описание

Отдаёт возможных дублёров

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/possibleDuplicates

Описание

Отдаёт возможных дублёров клиента на основе реквеста

Параметры в запросе
Название Тип Описание
name string

contactInfo Коллекция

Возможные типы: ContactInfo

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/contractorHuman/{id}/responsibles

Описание

Добавление ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

Тело запроса
Объединение
Возможные типы:
Employee

ContractorHuman

Тип ответа
boolean



DELETE
/api/v3/contractorHuman/{id}/responsibles/{responsibleContentType}/{responsibleId}

Описание

Удаление ответственных

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

responsibleContentType* string

contentType ответственного

responsibleId* integer

Идентификатор ответственного

Тип ответа
boolean



GET
/api/v3/contractorHuman/addressTypes

Описание

Отдаёт типы адресов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: AddressType



POST
/api/v3/contractorHuman/{id}/merge

Описание

Объединение контрагентов.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



POST
/api/v3/contractorHuman/{id}/similar

Описание

Помечаем как "похожие"

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Тип ответа
boolean



GET
/api/v3/contractorHuman/{id}/similar

Описание

Отдаёт помеченных как "похожие"

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/{entityId}/tasks

Описание

Отдаёт все задачи переданного клиента

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор контрагента

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/contractorHuman/{entityId}/actualTasks

Описание

Отдаёт все актуальные подзадачи переданной задачи.

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор контрагента

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/contractorHuman/{id}/deals

Описание

Получить cделки

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/contractorHuman/{entityId}/deals/extraFields

Описание

Получение расширенных полей сделки

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор контрагента

fieldNames Коллекция

Возможные типы: string

Массив названий запрашиваемых полей

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/contractorHuman/{id}/groups

Описание

Возвращает группы в которых содержится контрагент

Параметры в запросе
Название Тип Описание
id* string

Идентификатор сущности

withFixedFilters boolean

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CrmFilter



DELETE
/api/v3/contractorHuman/{id}

Описание

Перманентное удаление клиента

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

Тело запроса
DeleteActionRequest

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/{id}/invoices

Описание

Список счетов по контрагенту

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Invoice



POST
/api/v3/contractorHuman/{id}/payers

Описание

Создание нового плательщика

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

Тело запроса
Payer

Тип ответа
Payer



GET
/api/v3/contractorHuman/{id}/payers

Описание

Список плательщиков клиента

Параметры в запросе
Название Тип Описание
id* string

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Payer



GET
/api/v3/contractorHuman/{id}/commentTransportEmailTo

Описание

Список почтовых адресов которым можно отправить комментарий

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор контрагента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContactInfo



GET
/api/v3/contractorHuman/initialCreatedOwnCompany

Описание

Возвращает исходный идентификатор компании "Наша компания"

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/{id}/contacts

Описание

Список контактов по контрагенту

Параметры в запросе
Название Тип Описание
id* string

Идентификатор клиента

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



GET
/api/v3/contractorHuman/{id}/allParticipants

Описание

Получение всех текущих участников клиента

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/contractorHuman/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/contractorHuman/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/contractorHuman/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/contractorHuman/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/contractorHuman/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/contractorHuman/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/contractorHuman/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/contractorHuman/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/contractorHuman/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/contractorHuman/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/contractorHuman/tags

Описание

Получить варианты тегов для сущности

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/contractorHuman/tags/{id}

Описание

Создание/обновление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тело запроса
Tag

Тип ответа
Tag



DELETE
/api/v3/contractorHuman/tags/{id}

Описание

Удаление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тип ответа
Tag



GET
/api/v3/contractorHuman/{entityId}/tags

Описание

Получить все привязанные теги для конкретной сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



DELETE
/api/v3/contractorHuman/{entityId}/tags/{tagId}

Описание

Отвязать тег от сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

tagId* integer

Идентификатор тега

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/contractorHuman/{id}/tags

Описание

Добавление тегов сущности.Метку может добавлять любой сотрудник к любой сущности к которой у него есть доступ.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Tag

Тип ответа
BaseEntity



GET
/api/v3/contractorHuman/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



POST
/api/v3/contractorHuman/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/contractorHuman/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/contractorHuman/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/contractorHuman/{entityId}/relationLinks/{id}

Описание

Добавление/обновление ссылок

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор ссылки

Тело запроса
RelationLink

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractorHuman/{entityId}/relationLinks

Описание

Получение списка связей для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractorHuman/{entityId}/relationLinks/{id}

Описание

Получение связи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Идентификатор связи

Тип ответа
RelationLink



DELETE
/api/v3/contractorHuman/{entityId}/relationLinks/{id}

Описание

Удаление связной ссылки

Параметры в запросе
Название Тип Описание
entityId* string

Идентификатор сущности

id* integer

Идентификатор ссылки

Тип ответа
boolean



GET
/api/v3/contractorHuman/{id}/links

Описание

Все связанные ссылки задачи и ее комментариев

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/contractorHuman/{id}/docTemplates

Описание

Отдаёт шаблоны документов сущности (контрагент, задача, проект, сделка)

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



GET
/api/v3/contractorHuman/{id}/templateFields/{templateId}

Описание

Отдаёт переменные из шаблона заполненные данными по клиенту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

templateId* integer

Идентификатор шаблона

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/contractorHuman/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/contractorHuman/{id}/reminder

Описание

Обновление напоминания

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
ReminderTimeRequest

Тип ответа
BaseEntity



GET
/api/v3/contractorHuman/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/contractorHuman/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



POST
/api/v3/contractorHuman/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/contractorHuman/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/contractorHuman/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/contractorHuman/templateVariables

Описание

Возвращает пременные шаблона

Параметры в запросе
Название Тип Описание
onlyForFileName boolean

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/contractorHuman/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction



GET
/api/v3/contractorHuman/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/contractorHuman/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/contractorHuman/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/contractorHuman/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField




Налог

2
Контроллер для работы с налогами

GET
/api/v3/tax

Описание

Список возможных налогов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tax



GET
/api/v3/tax/base

Тип ответа
Tax




Плательщик

7
Контроллер для работы с плательщиками

DELETE
/api/v3/payer/{id}

Описание

Удаление плательщика

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Объединение
Возможные типы:
boolean

any



GET
/api/v3/payer/extraFields/{country}/{payerType}

Описание

Список всех возможных экст-полей плательщиков по типу и стране

Параметры в запросе
Название Тип Описание
country* string

payerType* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/payer/extraFields

Описание

Список всех полей плательщиков, для которых установлена настройка "Выводить в таблицах"

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/payer/{id}

Описание

Получение плательщика по id

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
Объединение
Возможные типы:
Payer

boolean



GET
/api/v3/payer

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Payer



POST
/api/v3/payer/{id}

Описание

Обновление плательщика

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Payer

Тип ответа
Payer



GET
/api/v3/payer/ownRecipients

Описание

Получение списка возможных получателей (плательщики с типом "Наша компания")

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Payer




Позиция счета

3

POST
/api/v3/offerRow/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
OfferRow

Тип ответа
Коллекция

Возможные типы: BaseEntity



DELETE
/api/v3/offerRow/{id}

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/offerRow/extraFields

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField




Сделка

69
Контроллер для работы со сделками

POST
/api/v3/deal

Описание

Создать новую сделку

Тело запроса
Deal

Тип ответа
Deal



GET
/api/v3/deal/{id}

Описание

Получить сделку

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сделки

Тип ответа
Deal



POST
/api/v3/deal/{id}

Описание

Обновить сделку

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сделки

Тело запроса
Deal

Тип ответа
Deal



DELETE
/api/v3/deal/{id}

Описание

Удалить сделку

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сделки

Тип ответа
boolean



POST
/api/v3/deal/{dealId}/applyTransition

Описание

Применить переход к сделке

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

Тело запроса
ProgramTransition

Тип ответа
Deal



POST
/api/v3/deal/{dealId}/applyTrigger

Описание

Применить триггер к сделке

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

Тело запроса
ProgramTrigger

Тип ответа
Deal



GET
/api/v3/deal

Описание

Получение списка сделок

Параметры в запросе
Название Тип Описание
filter TradeFilter

status ProgramState

q string

baseOn BaseEntity

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/deal/{dealId}/auditors

Описание

Получение аудиторов

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/deal/{dealId}/auditors

Описание

Добавление аудитора

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

Тело запроса
Employee

Тип ответа
Deal



DELETE
/api/v3/deal/{dealId}/auditors/{auditorId}

Описание

Удаление аудитора

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

auditorId* integer

Идентификатор аудитора

Тип ответа
Deal



POST
/api/v3/deal/{dealId}/{extraFieldName}

Описание

Добавление сотрудника в расширенное поле

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

extraFieldName* string

Имя расширенного поля

Тело запроса
Employee

Тип ответа
Deal



DELETE
/api/v3/deal/{dealId}/{extraFieldName}/{employeeId}

Описание

Удаление сотрудника из расширенного поля

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

extraFieldName* string

Имя расширенного поля

employeeId* integer

Идентификатор сотрудника

Тип ответа
Deal



GET
/api/v3/deal/employees

Описание

Получить список пользователей для поля

Параметры в запросе
Название Тип Описание
id integer

programId integer

fieldName string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Employee

ContractorHuman



GET
/api/v3/deal/checkDealExist

Описание

Проверка существования сделки

Параметры в запросе
Название Тип Описание
filter TradeFilter

status ProgramState

query string

deal Deal

Тип ответа
boolean



GET
/api/v3/deal/{dealId}/statusHistory

Описание

Получение истории изменения статуса

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealStatusHistory



GET
/api/v3/deal/{dealId}/possibleTriggers

Описание

Получение возможных триггеров

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ProgramTrigger



GET
/api/v3/deal/{dealId}/offerRows

Описание

Получение позиций сделки

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

q string

filter OfferFilter

warehouse Warehouse

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: OfferRow



POST
/api/v3/deal/{id}/sortOfferRows

Описание

Сортировка позиций сделки

Параметры в запросе
Название Тип Описание
id* integer

Не используется

Тело запроса
OfferRowSortRequest

Тип ответа
BaseEntity



GET
/api/v3/deal/prepared

Описание

Получить подготовленную несохраненную сделку

Параметры в запросе
Название Тип Описание
status ProgramState

fields any

Тип ответа
Deal



GET
/api/v3/deal/{entityId}/linkedTasks

Описание

Возвращает связанные задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сделки

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/deal/{entityId}/actualLinkedTasks

Описание

Возвращает актуальные связанные задачи

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сделки

filters Коллекция

Возможные типы: TaskResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Task

Project



GET
/api/v3/deal/{entityId}/linkedDeals

Описание

Возвращает актуальные связанные сделки

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сделки

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/deal/{entityId}/basedOnLinkedDeals

Описание

Возвращает список id сделок, которые созданы на основании текущего объекта

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сделки

Тип ответа
BasedOnDealIds



GET
/api/v3/deal/{id}/invoices

Описание

Список счетов

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сделки

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Invoice



GET
/api/v3/deal/{dealId}/payers

Описание

Список плательщиков по клиенту в сделке

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Payer



GET
/api/v3/deal/{dealId}/contacts

Описание

Список контактов по клиенту в сделке

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

ContractorCompany

ContractorHuman



POST
/api/v3/deal/{dealId}/fixCyRate

Описание

Фиксирует валюту во всех денежных полях сделки и ее позиций, для того, что бы при расчтеахиспользовалась именно зафиксированная валюта, а не текущая

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

Тип ответа
Deal



GET
/api/v3/deal/{dealId}/commentTransportEmailTo

Описание

Список почтовых адресов которым можно отправить комментарий в этой сделке

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContactInfo



GET
/api/v3/deal/duplicates

Описание

Список дубликатов по имени сделки

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Deal



GET
/api/v3/deal/lastUsedProgram

Описание

Программа по которой создавалась последний раз сделка

Тип ответа
Program



GET
/api/v3/deal/{dealId}/contractor

Описание

Получение клиента по сделке

Параметры в запросе
Название Тип Описание
dealId* integer

Идентификатор сделки

Тип ответа
Объединение
Возможные типы:
ContractorCompany

ContractorHuman



GET
/api/v3/deal/{id}/allParticipants

Описание

Получение всех текущих участников сделки

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/deal/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



POST
/api/v3/deal/{id}/produce

Описание

Производство продукции

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

materialsWarehouse* Warehouse

productsWarehouse* Warehouse

Тип ответа
Deal



GET
/api/v3/deal/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



POST
/api/v3/deal/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/deal/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/deal/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/deal/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/deal/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/deal/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/deal/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/deal/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/deal/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/deal/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



POST
/api/v3/deal/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/deal/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/deal/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo



GET
/api/v3/deal/tags

Описание

Получить варианты тегов для сущности

Параметры в запросе
Название Тип Описание
name string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/deal/tags/{id}

Описание

Создание/обновление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тело запроса
Tag

Тип ответа
Tag



DELETE
/api/v3/deal/tags/{id}

Описание

Удаление тега

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор тега

Тип ответа
Tag



GET
/api/v3/deal/{entityId}/tags

Описание

Получить все привязанные теги для конкретной сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Tag



DELETE
/api/v3/deal/{entityId}/tags/{tagId}

Описание

Отвязать тег от сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

tagId* integer

Идентификатор тега

Тип ответа
Коллекция

Возможные типы: Tag



POST
/api/v3/deal/{id}/tags

Описание

Добавление тегов сущности.Метку может добавлять любой сотрудник к любой сущности к которой у него есть доступ.

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Tag

Тип ответа
BaseEntity



POST
/api/v3/deal/{id}/linkWith

Описание

Привязка к сущности

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/deal/{id}/unlinkWith

Описание

Отмена привязки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
BaseEntity

Тип ответа
BaseEntity



GET
/api/v3/deal/{id}/linkedDealsByProgram

Описание

Возвращает схемы связанных сделок

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор задачи

filters Коллекция

Возможные типы:

DealProgramsFilter

DealResultTypeFilter

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: DealsByProgram



GET
/api/v3/deal/{id}/docTemplates

Описание

Отдаёт шаблоны документов сущности (контрагент, задача, проект, сделка)

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Doc



GET
/api/v3/deal/{id}/templateFields/{templateId}

Описание

Отдаёт переменные из шаблона заполненные данными по клиенту

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор клиента

templateId* integer

Идентификатор шаблона

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Variable



GET
/api/v3/deal/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



POST
/api/v3/deal/{id}/reminder

Описание

Обновление напоминания

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
ReminderTimeRequest

Тип ответа
BaseEntity



GET
/api/v3/deal/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/deal/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/deal/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/deal/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/deal/{modelId}/allFiles

Описание

Получение файлов

Параметры в запросе
Название Тип Описание
type string

Тип искомого файла (audio|image|other)

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/deal/{modelId}/allLinks

Описание

Получение связей

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

modelId* integer

Идентификатор модели

Тип ответа
Коллекция

Возможные типы: RelationLink



GET
/api/v3/deal/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction



GET
/api/v3/deal/templateVariables

Описание

Возвращает пременные шаблона

Параметры в запросе
Название Тип Описание
onlyForFileName boolean

Тип ответа
Коллекция

Возможные типы: Variable




Сделка. Статус

1

GET
/api/v3/programState/{id}

Описание

Получить состояние схемы

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
ProgramState




Сделка. Схема сделки

9
Контроллер для работы со схемами сделок

GET
/api/v3/program/{id}

Описание

Получить схему сделки

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор схемы

Тип ответа
Program



POST
/api/v3/program/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
Program

Тип ответа
Program



GET
/api/v3/program/{id}/fields

Описание

Получить список экст полей программы

Параметры в запросе
Название Тип Описание
id* string

fieldNames Коллекция

Возможные типы: string

Массив названий запрашиваемых полей

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/program/{id}/states

Описание

Получить список статусов программы

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ProgramState



GET
/api/v3/program/{id}/entryPoints

Описание

Получить список статусов-входных точек программы

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ProgramState



GET
/api/v3/program

Описание

Получить список активных схем сделок

Параметры в запросе
Название Тип Описание
withPossibleActions Коллекция

Возможные типы: string

Список возможных действий

withInactivePrograms boolean

Получить в том числе неактивные схемы

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Program



GET
/api/v3/program/slug/{slug}

Описание

Получить программу по полю slug

Параметры в запросе
Название Тип Описание
slug* string

Тип ответа
Program



GET
/api/v3/program/{id}/triggers

Параметры в запросе
Название Тип Описание
id* string

type string

Тип ответа
Коллекция

Возможные типы: ProgramTrigger



GET
/api/v3/program/{id}/commonPossibleStatusesTo

Описание

Получить список статусов, в которые в принципе возможен переход для данного пользователя с учетом прав

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ProgramState




Сделка. Сценарий

2
Контроллер для работы с триггерами

GET
/api/v3/programTrigger/{id}

Описание

Получить триггер

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
ProgramTrigger



POST
/api/v3/programTrigger/{id}

Описание

Обновить триггер

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тело запроса
ProgramTrigger

Тип ответа
ProgramTrigger




Системные настройки

4
Контроллер системных настроек

GET
/api/v3/systemSetting/{id}

Описание

id представляет собой строку: {scope}/{id}Для получения всех настроек по scope передается id в виде {scope}Для получения конкретной настройки необходимо передать параметр {scope}/{id}На данный момент доступен только один scope = callServerConfig - серверные настройки для телефонии

Параметры в запросе
Название Тип Описание
id* string

Идентификатор настройки в скоупе

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: SystemSetting



POST
/api/v3/systemSetting/{id}

Описание

Редактирование системной настройки по скоупу и идентификатору.

Параметры в запросе
Название Тип Описание
id* string

Идентификатор настройки в скоупе

Тело запроса
SystemSetting

Тип ответа
Объединение
Возможные типы:
SystemSetting

boolean



POST
/api/v3/systemSetting

Описание

Создание системной настройки по идентификатору в указанном скоупе.

Тело запроса
SystemSetting

Тип ответа
Объединение
Возможные типы:
SystemSetting

boolean



DELETE
/api/v3/systemSetting/{id}

Описание

Удаление настройки

Параметры в запросе
Название Тип Описание
id* string

Идентификатор настройки в скоупе

Тип ответа
boolean




Сотрудник

49
Контроллер для работы с сотрудниками

GET
/api/v3/employee/birthdays

Параметры в запросе
Название Тип Описание
startDate DateOnly

daysCount integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/subordinates

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/controlled

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/canInstallApp

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/employee/{id}

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
Employee

Тип ответа
Employee



POST
/api/v3/employee/{id}/fire

Описание

Увольнение сотрудника

Параметры в запросе
Название Тип Описание
id* string

Тело запроса
Employee

Тип ответа
Employee



GET
/api/v3/employee/{id}/prepareFire

Описание

Отдает подготовительную информацию для увольнения сотрудника

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
EmployeeFireInfo



GET
/api/v3/employee/{id}/delegatedEmployees

Описание

Сотрудники, которым можно поручить все дела увольняемого сотрудника

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/{id}/invisibleDepartments

Описание

Отделы, невидимые сотруднику

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Department



POST
/api/v3/employee/{id}/restoreFired

Описание

Взять сотрудника обратно после увольнения

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
Employee



DELETE
/api/v3/employee/{id}

Описание

Удалить сотрудника

Параметры в запросе
Название Тип Описание
id* integer

Тип ответа
boolean



POST
/api/v3/employee/{id}/block

Описание

Блокировка сотрудника

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
Employee



POST
/api/v3/employee/{id}/unblock

Описание

Разблокировка сотрудника

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
Employee



GET
/api/v3/employee/{id}/closestVacation

Описание

Ближайший подтвержденный отпуск сотрудника

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
Vacation



GET
/api/v3/employee/{id}/vacations

Описание

Список предстоящих (и текущего) отпусков сотрудника

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Vacation



GET
/api/v3/employee/{id}/activity

Описание

Лента активности

Параметры в запросе
Название Тип Описание
id* string

period string

За какой период возвращать ленту активности

types Коллекция

Возможные типы: string

Какие типы действий возвращать

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Notification



GET
/api/v3/employee/{id}/subordinates

Описание

Подчиненные

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/{id}/subordinatesCanBeDeleted

Описание

Подчиненные, которых можно удалить

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/employee/{id}/subordinates

Описание

Добавление подчиненного

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Employee

Тип ответа
boolean



DELETE
/api/v3/employee/{id}/subordinates/Employee/{subordinateId}

Описание

Удаление подчиненного

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

subordinateId* integer

Идентификатор подчиненного

Тип ответа
boolean



GET
/api/v3/employee/{id}/chiefs

Описание

Начальники

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/{id}/chiefsCanBeDeleted

Описание

Начальники, которых можно удалить

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/employee/{id}/chiefs

Описание

Добавление начальника

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Employee

Тип ответа
boolean



DELETE
/api/v3/employee/{id}/chiefs/Employee/{chiefId}

Описание

Удаление начальника

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

chiefId* integer

Идентификатор начальника

Тип ответа
boolean



GET
/api/v3/employee/{id}/coordinators

Описание

Координаторы

Параметры в запросе
Название Тип Описание
id* string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/employee/{id}/coordinators

Описание

Добавление координатора

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Employee

Тип ответа
boolean



DELETE
/api/v3/employee/{id}/coordinators/Employee/{coordinatorId}

Описание

Удаление координатора

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

coordinatorId* integer

Идентификатор подчиненного

Тип ответа
boolean



GET
/api/v3/employee/{id}

Параметры в запросе
Название Тип Описание
id* string

Тип ответа
Employee



GET
/api/v3/employee

Описание

Получение списка сотрудниковМожно фильтровать по placeholder

Параметры в запросе
Название Тип Описание
filter EmployeeFilter

Идентификатор или конфиг фильтра

q string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/{employeeId}/productivity

Описание

Получение продуктивности

Параметры в запросе
Название Тип Описание
interval string

type AbstractProductivityType

employeeId* integer

Тип ответа
Коллекция

Возможные типы: Productivity



POST
/api/v3/employee/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/employee/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/employee/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/employee/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/employee/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/employee/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/employee/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/employee/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/employee/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/employee/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/employee/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/employee/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/employee/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/employee/search

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/employee/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/employee/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/employee/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/employee/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



GET
/api/v3/employee/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




Счет

9
Работа со списками счетов

POST
/api/v3/invoice/{id}

Описание

Обновления существующего счета

Параметры в запросе
Название Тип Описание
id* string

Идентификатор счета, который необходимо обновить

Тело запроса
Invoice

Тип ответа
Invoice



POST
/api/v3/invoice

Описание

Создать новый счет

Тело запроса
Invoice

Тип ответа
Invoice



GET
/api/v3/invoice/realAccounts

Описание

Список расчетных счетов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: any



GET
/api/v3/invoice/template

Описание

Получить список доступных шаблонов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: any



GET
/api/v3/invoice

Описание

Список счетов

Параметры в запросе
Название Тип Описание
statusFilterId string

periodFilterId string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Invoice



GET
/api/v3/invoice/{id}

Описание

Получить счет по id

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

Тип ответа
Invoice



GET
/api/v3/invoice/{id}/rows

Описание

Получить позиции счета по id

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: OfferRow



DELETE
/api/v3/invoice/{id}

Описание

Удалить счет

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор счета для удаления

Тип ответа
void



GET
/api/v3/invoice/templateVariables

Описание

Возвращает пременные шаблона

Параметры в запросе
Название Тип Описание
onlyForFileName boolean

Тип ответа
Коллекция

Возможные типы: Variable




Телефония. Группа обзвона

1
Маршрут звонка, используется для определения сотрудника ответсвенного по клиенту с номером телефона звонящего

GET
/api/v3/callRoute

Описание

Получение карты обзвона сотрудников по номеру телефона входящего звонка.Определяет ответсвенного и отдает его внутренний номер телефона из настроек телефонии

Параметры в запросе
Название Тип Описание
phone string

Телефон клиента для поиска ответственного по нему

Тип ответа
CallRoute




Телефония. Звонок

12
Контроллер для работы с телефонией

GET
/api/v3/callInfo

Описание

Список созданных звонков в системе

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CallInfo



GET
/api/v3/callInfo/provider

Описание

Получение звонков по идентификатору установленному со стороны провайдера телефонии.

Параметры в запросе
Название Тип Описание
providerId* any

Идентификатор провайдера телефонии.()

Тип ответа
CallInfo



GET
/api/v3/callInfo/history

Описание

TODO: Хоть выше и есть какой-то эндпоинт, но я заблудился в терминах и провайдер айди не тоже,TODO: что и provider.name

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CallInfo



POST
/api/v3/callInfo/provider

Описание

Редактирование сущности звонка по id, установленному со стороны провайдера телефонии.В случае, если в системе будет найдено несколько сущностей с заданным providerId,редактироваться будет самый последний звонок.В данно запросе параметр providerId является обязательным.

Тело запроса
CallInfo

Тип ответа
CallInfo



GET
/api/v3/callInfo/{id}

Описание

Получение звонка по его Id

Параметры в запросе
Название Тип Описание
id* integer

Id звонка в Мегаплане

Тип ответа
CallInfo



POST
/api/v3/callInfo

Описание

Создание сущности звонка, при этом у пользователя активируется виджет телефонии с соответсвующим режимом.Входящий или исходящий определяется по типу в передаваемой CallInfo.Текущий статус звонка (звонок, разговор и т.д.) определяется по state в CallInfo.

Тело запроса
CallInfo

Тип ответа
CallInfo



POST
/api/v3/callInfo/history

Описание

Создание истории звонков, передается массив CallInfo, сущности создаются или обновляются в завершённом статусе.Событие в виджет телефонии не передается.

Тело запроса
Коллекция

Возможные типы: CallInfo

Тип ответа
Коллекция

Возможные типы: CallInfo



POST
/api/v3/callInfo/{id}

Описание

Обновление существующего звонка, изменение данных, например переходзвонка из одного состояния в другое или добавление записи разговора, при этом событие передается в виджет телефонии

Параметры в запросе
Название Тип Описание
id* integer

Id звонка в Мегаплане

Тело запроса
CallInfo

Тип ответа
CallInfo



POST
/api/v3/callInfo/{id}/setContractor

Описание

Прикрепление клиента к звонку - в случае входящего и пропущенного запишется в поле fromUser, в случае исходящегов поле toUser. При наличии сопоставленной со звонком коммуникации добавит или заменит текущего клиента в ней.

Параметры в запросе
Название Тип Описание
id* integer

Тело запроса
Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Тип ответа
CallInfo



POST
/api/v3/callInfo/{entityId}/todos

Описание

Создание события

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Todo

Тип ответа
Todo



GET
/api/v3/callInfo/{entityId}/todos

Описание

Получение событий для таска

Параметры в запросе
Название Тип Описание
finished boolean

Показывать только завершенные

all boolean

Показывать все дела

period string

За какой период возвращать дела

sortable boolean

Использовать ли сохраненную сортировку?

filters Коллекция

Возможные типы: TodoDateTimeFilter

q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: Todo



POST
/api/v3/callInfo/{entityId}/todos/sort

Описание

Сортировка списка дел

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
TodoOrderRequest

Тип ответа
Коллекция

Возможные типы: Todo




Телефония. Настройки пользователя

6
Пользовательские настройки телефонии

GET
/api/v3/callUserConfig

Описание

Получение списка пользовательских настроек телефонии по всем сотрудникам

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: CallUserConfig



GET
/api/v3/callUserConfig/{id}

Описание

Получение пользовательской настройки по id

Параметры в запросе
Название Тип Описание
id* integer

Id настройки

Тип ответа
CallUserConfig



POST
/api/v3/callUserConfig

Описание

Создание настройки пользователя телефонии

Тело запроса
CallUserConfig

Тип ответа
CallUserConfig



POST
/api/v3/callUserConfig/{id}

Описание

Редактирование пользовательской настройки телефонии

Параметры в запросе
Название Тип Описание
id* integer

Id настройки при редактировании или null при создании

Тело запроса
CallUserConfig

Тип ответа
CallUserConfig



GET
/api/v3/callUserConfig/Employee/{id}

Описание

Получение списка пользовательских настроек телефонии по сотруднику

Параметры в запросе
Название Тип Описание
id* integer

Id сотрудника

Тип ответа
CallUserConfig



DELETE
/api/v3/callUserConfig/Employee/{id}

Описание

Удаление списка пользовательских настроек телефонии по сотруднику

Параметры в запросе
Название Тип Описание
id* integer

Id сотрудника

Тип ответа
boolean




Тип клиента

3
Контроллер для работы с типами клиента

GET
/api/v3/contractorType/{id}

Описание

Получение типа клиента

Параметры в запросе
Название Тип Описание
id* string

Идентификатор типа клиента

Тип ответа
ContractorType



GET
/api/v3/contractorType

Описание

Получение списка типов клиентов

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: ContractorType



POST
/api/v3/contractorType/{id}

Описание

Обновление типа

Параметры в запросе
Название Тип Описание
id* string

Идентификатор типа

Тело запроса
ContractorType

Тип ответа
ContractorType




Товары

27
Контроллер для работы с товарами

POST
/api/v3/offer

Описание

Создание нового товара

Тело запроса
Offer

Тип ответа
Offer



POST
/api/v3/offer/{id}

Описание

Обновление существующего товара

Параметры в запросе
Название Тип Описание
id* integer

Id товара, который нужно обновить

Тело запроса
Offer

Тип ответа
Offer



DELETE
/api/v3/offer/{id}

Описание

Удаление товара

Параметры в запросе
Название Тип Описание
id* integer

Id товара, который нужно удалить

Тип ответа
void



GET
/api/v3/offer/{id}

Описание

Запрос на получение конкретного товара

Параметры в запросе
Название Тип Описание
id* integer

Id товара, который нужно получить

Тип ответа
Offer



GET
/api/v3/offer/{offerId}/parts

Описание

Получение всех товаров в комплекте

Параметры в запросе
Название Тип Описание
offerId* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: OfferPart



GET
/api/v3/offer/{offerId}/parents

Описание

Возвращает список комплектов, в которых есть товар

Параметры в запросе
Название Тип Описание
offerId* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: OfferPart



GET
/api/v3/offer

Описание

Запрос на получение всех товаров

Параметры в запросе
Название Тип Описание
q string

filter OfferFilter

warehouse Warehouse

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Offer



GET
/api/v3/offer/{id}/allParticipants

Описание

Получение всех текущих участников клиента

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/offer/{id}/attaches

Описание

Получение вложениЙ

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: File



GET
/api/v3/offer/{id}/balances

Описание

Получение баланса

Параметры в запросе
Название Тип Описание
id* integer

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: WarehouseBalance



POST
/api/v3/offer/{id}/produce

Описание

Производство товара

Параметры в запросе
Название Тип Описание
id* integer

materialsWarehouse* Warehouse

productsWarehouse* Warehouse

amount* number

Тип ответа
Коллекция

Возможные типы: any



GET
/api/v3/offer/extraFields

Описание

Получить список полей для сущности

Параметры в запросе
Название Тип Описание
pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/offer/{entityId}/extraFields/{id}

Описание

Обновить сущность

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

id* integer

Неиспользуемый идентификатор

Тело запроса
BaseEntity

Тип ответа
BaseEntity



POST
/api/v3/offer/extraFields/{id}

Описание

Создание нового поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Тип ответа
Коллекция

Возможные типы:

BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



DELETE
/api/v3/offer/extraFields/{id}

Описание

Удаление поля

Параметры в запросе
Название Тип Описание
id* integer

Идентификатор поля

Тип ответа
Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField



POST
/api/v3/offer/{entityId}/comments/markAsRead

Описание

Помечает комментарии прочитанными

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
Коллекция

Возможные типы: BaseEntity



GET
/api/v3/offer/{entityId}/comments

Описание

Список комментариев для сущности

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: any

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Comment

FieldChange

BasedOnHistory



GET
/api/v3/offer/{entityId}/subscribers

Описание

Возвращает подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



POST
/api/v3/offer/{entityId}/comments

Описание

Создание комментария

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
Объединение
Возможные типы:
CommentCreateActionRequest

Comment

Тип ответа
Comment



GET
/api/v3/offer/{entityId}/possibleSubscribers

Описание

Возвращает возможных подписчиков(пользователей) на комментарии

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Employee



GET
/api/v3/offer/{entityId}/comments/settings

Описание

Получить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тип ответа
CommentSettings



POST
/api/v3/offer/{entityId}/comments/settings

Описание

Сохранить настройки комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

Тело запроса
CommentSettings

Тип ответа
CommentSettings



GET
/api/v3/offer/{entityId}/comments/transports

Описание

Получить доступные транспорты комментариев

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы: Smtp



GET
/api/v3/offer/{entityId}/comments/search

Параметры в запросе
Название Тип Описание
q string

Строка поиска

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

entityId* integer

Тип ответа
Коллекция

Возможные типы: Comment



POST
/api/v3/offer/{entityId}/checkMessagingEntity

Описание

Сущность, в которой уже ведется переписка

Параметры в запросе
Название Тип Описание
entityId* integer

Тело запроса
MessagingEntityChecker

Тип ответа
MessagingEntityChecker



GET
/api/v3/offer/{entityId}/history

Описание

Журнал логов для сущности (контрактор, задача и т.д.)

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

filters Коллекция

Возможные типы: string

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Message

Comment

Changeset

SendingLog

LoyaltyActionLogSet



GET
/api/v3/offer/{entityId}/interactions

Описание

Список взаимодействий

Параметры в запросе
Название Тип Описание
entityId* integer

Идентификатор сущности

action string

contentTypes Коллекция

Возможные типы: string

Типы сущностейЕсли null - ищем во всех поддерживаемых сущностях.

pageAfter BaseEntity

Загрузить страницу, начиная с переданной сущности.

pageBefore BaseEntity

Загрузить страницу строго до переданной сущности.

pageWith BaseEntity

Загрузить страницу c наличием переданной сущности.

limit integer

Сколько элементов включать в страницу.

fields any

Набор дополнительных полей, включённых в список

sortBy Коллекция

Возможные типы: SortField

массив полей сортировки

onlyRequestedFields boolean

отдавать только перечисленные поля

Тип ответа
Коллекция

Возможные типы:

Interaction

ReadInteraction




Сущности

604

Megaplan\Api3\Entity\AnotherExampleEntity

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AnotherExampleEntity
description string

createdAt DateTime

id string

Идентификатор

Megaplan\Api3\Entity\ApiCall

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ApiCall
method* string

Возможные варианты: GET, POST, PUT, PATCH, DELETE

HTTP-method

url* string

URL part after domain

body string

Request body content

Megaplan\Api3\Entity\BaseEntity

Описание

Base for entity objects

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BaseEntity
id string

Идентификатор

Megaplan\Api3\Entity\BaseValue

Описание

Base for value objects

Megaplan\Api3\Entity\BulkApiCall

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BulkApiCall
calls* Коллекция

Возможные типы: ApiCall

Megaplan\Api3\Entity\Example

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Example
price* integer

description string

codes Коллекция

Возможные типы: integer

avatars Коллекция

Возможные типы: string

parents Коллекция

Возможные типы: Example

parentsCount integer

parent Example

children Коллекция

Возможные типы: BaseEntity

childrenCount integer

firstChildren BaseEntity

entityFromAlias AnotherExampleEntity

entityFromSameNamespace Объединение
Возможные типы:
AnotherExampleEntity

Example

recipients Коллекция

Возможные типы:

AnotherExampleEntity

Example

recipientsCount integer

createdAt DateTime

money Money

mixed any

id string

Идентификатор

Megaplan\Api3\Entity\ExampleValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ExampleValue
score* integer

sourceId integer

bums\common\api\v03\daData\Entity\DaDataBank

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DaDataBank
name string

correspondentAccount string

bic string

address string

value string

status string

Возможные варианты: ACTIVE, LIQUIDATING, LIQUIDATED

bums\common\api\v03\daData\Entity\DaDataParty

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DaDataParty
name string

inn string

ogrn string

address string

kpp string

value string

status string

Возможные варианты: ACTIVE, LIQUIDATING, LIQUIDATED, REORGANIZING

type string

Возможные варианты: LEGAL, INDIVIDUAL

bums\common\api\v03\edata\Entity\ParseError

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ParseError
entity string

message string

bums\common\api\v03\extFields\Entity\ExtraFieldParam

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ExtraFieldParam
name string

value string

bums\common\api\v03\extFields\Entity\FieldSetting

Описание

Настройки поля

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FieldSetting
name string

Название поля

enabled boolean

Включен

readOnly boolean

Только для чтения

bums\common\api\v03\extFields\Entity\Fields\BigIntField

Описание

Большое целое

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BigIntField
defaultValue integer

isIndexable boolean

Доступно для быстрого поиска

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\BoolField

Описание

Булев тип

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BoolField
defaultValue boolean

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\DateField

Описание

Тип дата

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateField
defaultValue DateTime

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\DateTimeField

Описание

Тип дата-время

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateTimeField
defaultValue DateTime

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\DurationField

Описание

Продолжительность

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DurationField
defaultValue string

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\EnumField

Описание

Перечисление

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EnumField
enumValues* Коллекция

Возможные типы: string

Массив значений

defaultValue string

Значения по умолчанию

newValuesAllowed boolean

Допустимы новые значения

isIndexable boolean

Доступно для быстрого поиска

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\ExternalSourceField

Описание

Внешнее поле

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ExternalSourceField
defaultValue string

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\FloatField

Описание

Числа с плавающей точкой

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FloatField
minValue integer

maxValue integer

defaultValue number

isUnique boolean

isIndexable boolean

Доступно для быстрого поиска

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\IntegerField

Описание

Целые числа

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IntegerField
defaultValue integer

minValue integer

maxValue integer

isUnique boolean

isIndexable boolean

Доступно для быстрого поиска

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\MoneyField

Описание

Денежный тип

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MoneyField
defaultValue Money

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\RatingField

Описание

Рейтинговая оценка

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RatingField
minValue integer

maxValue integer

defaultValue number

isUnique boolean

isIndexable boolean

Доступно для быстрого поиска

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\RefLinkField

Описание

Ссылка на экземпляр другой модели

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RefLinkField
refContentType* Коллекция

Возможные типы: string

Массив contentType

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\RefSetField

Описание

Ссылки экземпляры другой модели

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RefSetField
refContentType* Коллекция

Возможные типы: string

Массив contentType

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\ResourceField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ResourceField
unitName string

representationType string

Возможные варианты: time, currency, other

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\extFields\Entity\Fields\StringField

Описание

Строка

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен StringField
isHtml boolean

maxLength integer

defaultValue string

isUnique boolean

isIndexable boolean

Доступно для быстрого поиска

name string

Название поля

hrName* string

Человекопонятное название поля

type string

Тип поля

isRequired boolean

Обязательное поле

isMultiple boolean

Множественное значение

targetEntity string

Целевая сущность

settings Коллекция

Возможные типы: FieldSetting

Массив настроек

settingsCount integer

Количество настроек

orderPos integer

Позиция поля при сортировке

isSystem boolean

Системное поле

isSortable boolean

Сортируемое поле

owner BaseEntity

Сущность владельца

id string

Идентификатор

bums\common\api\v03\todo\Entity\Todo

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Todo
name* string

Название дела

status TodoStatus

Статус

place Place

Место проведения события

category TodoCategory

Категория

reminders Коллекция

Возможные типы: Reminder

Массив напоминаний

remindersCount integer

Количество напоминаний

resultComment Comment

Результирующий комментарий

timeFinished DateTime

Время окончания

timeCreated DateTime

isNeedResult boolean

Нужен результат

when Объединение
Возможные типы:
IntervalDates

IntervalTime

Временной интервал события

responsible Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Ответственный

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

Создатель

isTemplate boolean

Является ли шаблоном для повторяющихся задач

isDropped boolean

Является ли событие удаленным

isOverdue boolean

Является ли событие просроченным

schedule Schedule

Событие

description string

Описаиние

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

participants Коллекция

Возможные типы: Participant

Участники

participantsCount integer

Количество участников

relations Коллекция

Возможные типы:

Task

Project

Deal

ContractorCompany

ContractorHuman

CallInfo

Массив связанных сущностей

relationsCount integer

Количество связей

rights TodoRights

Список возможных действий

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_finish, act_renew, act_edit, act_accept_invite, act_reject_invite, act_give, act_cancel, act_delete, act_take, act_read

Список возможных действий (устарело)

contactInfo Коллекция

Возможные типы: ContactInfo

Массив с контактной информацией

contactInfoCount integer

Количество элементов в массиве с контактной информацией

linksCount integer

Количество всех связанных ссылок (с учетом журнала)

relationLinks Коллекция

Возможные типы: RelationLink

Связанные ссылки (только для этой сущности)

relationLinksCount integer

Количество связанных ссылок (только для этой сущности)

coincidentTodos Коллекция

Возможные типы: Todo

coincidentTodosCount integer

busyParticipants Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Участники дела, которые заняты во время текущего дела

busyParticipantsCount integer

Количество занятых участников дела

interactionsCounters Коллекция

Возможные типы: InteractionCounter

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

allFiles Коллекция

Возможные типы:

File

FileGroup

Массив файлов

allFilesCount integer

Количество файлов

attachesInfo AttachesInfo

Информация о вложении

conferenceParticipantsCount integer

Количество участников видеозвонка

conferenceSettings ConferenceSettings

bums\common\api\v03\todo\Entity\TodoAcceptInvitationActionRequest

Описание

Запрос принятия приглашения на участие в деле

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoAcceptInvitationActionRequest
changeMode string

Возможные варианты: changeCurrent, changeSequent

bums\common\api\v03\todo\Entity\TodoCategory

Описание

Категории дел

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoCategory
name string

Имя категории

masterType string

Возможные варианты: event, meeting, call, todo, private

Тип коммуникации

activeBgColor string

Активный цвет фона

bgColor string

Цвет фона

color string

Цвет

id string

Идентификатор

bums\common\api\v03\todo\Entity\TodoDeleteRepeatableActionRequest

Описание

Сущность, определяющая запрос на удаление дела, в котором присутствует повторение.Запрос нужен, так как в интерфейсе можно выбирать один из вариантов удаления— конкретное собыите, все последующие или весь шаблон

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoDeleteRepeatableActionRequest
todo Todo

deleteMode string

Возможные варианты: changeCurrent, changeSequent, changeTemplate

bums\common\api\v03\todo\Entity\TodoFinishActionRequest

Описание

Сущность, определяющая запрос на завершение дела

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoFinishActionRequest
status TodoStatus

resultText string

resultAttaches Коллекция

Возможные типы: File

notifyContractors boolean

bums\common\api\v03\todo\Entity\TodoGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoGroup
name string

id string

Идентификатор

bums\common\api\v03\todo\Entity\TodoOrderRequest

Описание

Запрос на сортировку дел

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoOrderRequest
current Todo

Текущее дело

after Todo

Следующее дело

bums\common\api\v03\todo\Entity\TodoRejectInvitationActionRequest

Описание

Запрос на отклонение приглашения об участии в делах

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoRejectInvitationActionRequest
changeMode string

Возможные варианты: changeCurrent, changeSequent

bums\common\api\v03\todo\Entity\TodoRenewActionRequest

Описание

Сущность, определяющая запрос на восстановление дела

bums\common\api\v03\todo\Entity\TodoRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoRights
read boolean

Чтение

edit boolean

Редактирование

remove boolean

Удаление

finish boolean

Завершить

cancel boolean

Отменить

renew boolean

Восстановить

give boolean

Передать

take boolean

Взять

acceptInvite boolean

Подтвердить приглашение

rejectInvite boolean

Отменить приглашение

id string

Идентификатор

bums\common\api\v03\todo\Entity\TodoStatus

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoStatus
name string

Имя статуса

masterType string

Возможные варианты: scheduled, finished, success, fail, finish_without_result

Тип статуса

id string

Идентификатор

bums\common\api\v03\todo\Entity\TodoTakeActionRequest

Описание

Сущность, определяющая запрос для забора дела себе

bums\common\api\v03\todo\Entity\TodosBusyDay

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodosBusyDay
date DateOnly

bums\common\call\api\v03\Entity\CallInfoJournal

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CallInfoJournal
timeCreated DateTime

type string

state string

title string

recordLinks Коллекция

Возможные типы: string

callParticipant Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

id string

Идентификатор

bums\common\common\api\v03\Controller\Request\DeleteActionRequest

Описание

Запрос на удаление сущности

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DeleteActionRequest
mode string

Возможные варианты: default_drop, only_fake_drop, force_drop

Режим

bums\common\common\api\v03\Controller\Request\DeviceTokenRequest

Описание

Class DeviceTokenRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DeviceTokenRequest
uuid* string

token* string

bums\common\common\api\v03\Controller\Request\NewFilterSettingsRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NewFilterSettingsRequest
forAllEmployees boolean

settings NewFilterSettings

bums\common\common\api\v03\Controller\Request\ReminderTimeRequest

Описание

Запрос времени напоминания

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReminderTimeRequest
mode* string

Возможные варианты: not_set, after_5_minutes, after_1_hour, tomorrow_morning, next_week, custom_date_time

Режим

customDateTime DateTime

Дата и время

bums\common\common\api\v03\Controller\Request\UserInterfaceLayoutRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UserInterfaceLayoutRequest
applyFor Коллекция

Возможные типы: string

Возможные варианты: forNewEmployees, forAllEmployees

entity* UserInterfaceLayout

bums\common\common\api\v03\Entity\ActivityDesktopWidget

Описание

Виджет ленты активности

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ActivityDesktopWidget
title string

Заголовок/название виджета

posX* integer

posY* integer

scale string

Возможные варианты: compact, iconic, spacious, free

Масштаб: компактный, портретный, просторный, свободный

id string

Идентификатор

bums\common\common\api\v03\Entity\Address

Описание

Адрес

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Address
type AddressType

Тип

value string

Значение

isMain boolean

Основной

city City

Город

street string

Улица

house string

Дом

metro Metro

Метро

bums\common\common\api\v03\Entity\AddressType

Описание

Тип адреса

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AddressType
name string

Название

id string

Идентификатор

bums\common\common\api\v03\Entity\Approval

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Approval
type string

time DateTime

deadline DateTime

entity BaseEntity

status string

owner BaseEntity

accept string

acceptAction string

reject string

rejectAction string

sort integer

id string

Идентификатор

bums\common\common\api\v03\Entity\AttachesInfo

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AttachesInfo
imageFiles Коллекция

Возможные типы: File

Файлы изображений

imageFilesCount integer

Количество файлов изображений

audioFiles Коллекция

Возможные типы: File

Звуковые файлы

audioFilesCount integer

Количество звуковых файлов

otherFiles Коллекция

Возможные типы: File

Другие файлы

otherFilesCount integer

Количество файлов другого типа

bums\common\common\api\v03\Entity\AudioFileMetadata

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AudioFileMetadata
duration integer

bums\common\common\api\v03\Entity\AuthenticatedRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AuthenticatedRequest
secret* string

type* string

Возможные варианты: password, google

prevAuthenticateRequest AuthenticatedRequest

bums\common\common\api\v03\Entity\AuthorizationRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AuthorizationRequest
hash* string

key* string

bums\common\common\api\v03\Entity\AutocompleteFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutocompleteFilter
contentTypes Коллекция

Возможные типы: string

q string

bums\common\common\api\v03\Entity\BasedOnDealIds

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BasedOnDealIds
value Коллекция

Возможные типы: string

bums\common\common\api\v03\Entity\BasedOnHistory

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BasedOnHistory
timeCreated DateTime

basedModel any

generatedModel any

user Employee

unlink boolean

description string

id string

Идентификатор

bums\common\common\api\v03\Entity\Burning

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Burning
time DateTime

entity BaseEntity

id string

Идентификатор

bums\common\common\api\v03\Entity\CalculatedField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CalculatedField
subject* BaseEntity

Объект

fieldName* string

Название поля

strategy* string

Возможные варианты: hierarchy_sum

Стратегия расчета

id string

Идентификатор

bums\common\common\api\v03\Entity\CardLayout

Описание

Базовый layout для блоков/карточек

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CardLayout
name* string

bums\common\common\api\v03\Entity\Changeset

Описание

Набор изменения полей

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Changeset
timeCreated DateTime

type string

Возможные варианты: create, drop, restore

changes Коллекция

Возможные типы: FieldChange

changesCount integer

entity Объединение
Возможные типы:
BaseEntity

BaseValue

generatedBy Объединение
Возможные типы:
BaseEntity

BaseValue

author Объединение
Возможные типы:
Employee

ContractorHuman

EntityDescription

ContractorCompany

id string

Идентификатор

bums\common\common\api\v03\Entity\City

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен City
name* string

Название

metros Коллекция

Возможные типы: Metro

metrosCount integer

id string

Идентификатор

bums\common\common\api\v03\Entity\Comment

Описание

Комментарий

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Comment
content string

Содержание

subject* Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Todo

Task

Project

Deal

FinOperation

Topic

Doc

Offer

Warehouse

Сущность

owner Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Владелец

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

timeCreated DateTime

Дата создания

timeUpdated DateTime

Дата обновления

isDropped boolean

Удален

completed integer

Процент завершения задачи

relationLinks Коллекция

Возможные типы: RelationLink

Связанные ссылки

relationLinksCount integer

Количество связанных ссылок

workTime DateInterval

Время работы

workDate DateTime

Дата списания времени workTime

isUnread boolean

Не прочитан

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_delete_comment, act_edit_comment, act_restore_comment, act_read

Список возможных действий

transportMessages Коллекция

Возможные типы:

Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

Если комментарий был отправлен через какие-то транспортыто здесь содержатся соотв. сущности сообщений

transportMessagesCount integer

Количество сообщений отправленных через какие-либо транспорты

originalComment Comment

Комментарий на который был дан ответ

isHidden boolean

Скрытый

wasRead boolean

Был прочитан

isLiked boolean

Был ли проставлен лайк текущим пользователем

likes Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Список пользователей проставивших лайк

likesCount integer

Количество лайков

answersCount integer

Количество ответов на комментарий

interactionsCounters Коллекция

Возможные типы: InteractionCounter

forwardFrom Объединение
Возможные типы:
Comment

Message

Ссылка на оригинальный комментарий, для комментариев созданных через пересылку

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

bums\common\common\api\v03\Entity\CommentCreateActionRequest

Описание

Сущность, определяющая запрос на создание комментарияНужна для передачи дополнительных "контроллерных" параметров, например, участников, которых надо уведомить

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CommentCreateActionRequest
comment Comment

Комментарий, который нужно создать

participantsToNotify Коллекция

Возможные типы:

Employee

ContractorHuman

Массив с участниками - кого надо форсированно уведомить.

transports Коллекция

Возможные типы:

EmailTransportConfig

FacebookTransport

TelegramTransportConfig

InstagramTransportConfig

WhatsappTransportConfig

Транспорты, через которые нужно отправить комментарий

bums\common\common\api\v03\Entity\CommentSettings

Описание

Настройки комментариев

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CommentSettings
deletedCommentsVisibility boolean

Отображение удаленных комментариев

commentsAutoScrollDisabled boolean

Автоскролл комментариев отключен

bums\common\common\api\v03\Entity\CommentTemplate

Описание

Шаблоны email'ов

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CommentTemplate
name* string

Название шаблона

subject string

Тема письма

content* string

Содержимое шаблона

timeCreated DateTime

Время создания

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Пользователь создавший шаблон

users Коллекция

Возможные типы:

Employee

Group

Список сотрудников, которым доступен данный шаблон

usersCount integer

key string

Дополнительный ключ, по которому можно фильтровтаь шаблоны

rights CommentTemplatePossibleActions

Допустимые действия с шаблоном для текущего пользователя

type string

Возможные варианты: without_variables, task_type, project_type, contractor_type, deal_type

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

id string

Идентификатор

bums\common\common\api\v03\Entity\CommentTemplatePossibleActions

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CommentTemplatePossibleActions
read boolean

Чтение

write boolean

Запись

id string

Идентификатор

bums\common\common\api\v03\Entity\ContactInfo

Описание

Контактная информация

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContactInfo
type string

Возможные варианты: email, jabber, icq, skype, link, phone, telegram, whatsapp, viber, instagram

Тип

value* string

Значение

comment string

Комментарий

isMain boolean

Основной

subject Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Ссылка на того чья это ContactInfo

bums\common\common\api\v03\Entity\ContactInfoLayout

Описание

Layout для блока 'Контактные данные'

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContactInfoLayout
collapsedContactTypes Коллекция

Возможные типы: string

Возможные варианты: emails, links, locations, messengers, phones

name* string

bums\common\common\api\v03\Entity\ContactsLayout

Описание

Layout для блока 'Контактные лица'

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContactsLayout
fullView boolean

name* string

bums\common\common\api\v03\Entity\Counter

Описание

System counters, where Counter.id is name of a counter

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Counter
count integer

Counter value itself

attributes Коллекция

Возможные типы: string

id string

Идентификатор

bums\common\common\api\v03\Entity\Country

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Country
name string

Название

isDefault boolean

По умолчанию

id string

Идентификатор

bums\common\common\api\v03\Entity\CrmExtraFieldsLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CrmExtraFieldsLayout
hiddenGroups Коллекция

Возможные типы: string

fixedFields Коллекция

Возможные типы: string

collapsedFixedGroups Коллекция

Возможные типы: string

collapsedGroups Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\DealContractorFields

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealContractorFields
fields Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\DefaultReminder

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DefaultReminder
type string

Возможные варианты: milestone, todo, task, project

reminder Reminder

bums\common\common\api\v03\Entity\DiskSpace

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DiskSpace
free integer

Свободное место в файловом хранилище

total integer

Доступное по тарифу место в файловом хранилище

used integer

Занятое место в файловом хранилище

id string

Идентификатор

bums\common\common\api\v03\Entity\DiskSpaceApproval

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DiskSpaceApproval
type string

Возможные варианты: storage_notice, storage_full

id string

Идентификатор

bums\common\common\api\v03\Entity\EmailTransportConfig

Описание

Параметры которые нужны транспорту email чтобы отправить сообщение

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmailTransportConfig
sign string

Подпись после сообщения

subject string

Тема сообщения

to Коллекция

Возможные типы: string

Адресат

from Объединение
Возможные типы:
Smtp

Megamail

Imap

Линк на сущность, от которой происходит отправка

referenceId string

Идентификатор ссылки

originalMessage Message

Сообщение

bums\common\common\api\v03\Entity\EntityDescription

Описание

Описание EntityПрименяется если мы не можем вытащить всю entity полностью (например, модель удалили из базы)Можно дополнять новыми полями по желанию, например, id

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EntityDescription
value string

bums\common\common\api\v03\Entity\Experiment

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Experiment
className string

tag string

bums\common\common\api\v03\Entity\ExperimentalModule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ExperimentalModule
isEnabled boolean

id string

Идентификатор

bums\common\common\api\v03\Entity\ExternalWindow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ExternalWindow
uuid string

src string

loginDelay integer

loginDelayMax integer

onlyPrimary boolean

bums\common\common\api\v03\Entity\ExtraFieldsLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ExtraFieldsLayout
collapsedGroups Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\Feature

Описание

Сущность "Фича".

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Feature
name* string

Возможные варианты: megaplan.api3.use_realtime_entities_updater_feature, bums.common.call.react_call_widget, bums.common.common.mass_action_limit_notifications, bums.common.common.offer_module_feature, bums.common.common.preserve_whitespaces, bums.common.common.react_global_search, bums.common.common.resize_image_in_c_viewer, bums.common.common.show_filters_block, bums.common.common.show_mass_action_apply_trigger, bums.common.common.show_one_time_key_url_in_qr_code, bums.common.common.show_warning_storage_full, bums.common.common.task_default, bums.common.common.activity_type_filter, bums.common.common.addons, bums.common.common.duplicate_comment_in_email_feature, bums.common.common.email_message_quoting, bums.common.common.email_widget_redesign, bums.common.common.exact_time_reminder_feature, bums.common.common.external_window_feature, bums.common.common.feedback, bums.common.common.filter_term_filled_comparison, bums.common.common.global_search_html, bums.common.common.hidden_comments_feature, bums.common.common.inbox_widget_redesign, bums.common.common.journal_email_redesign, bums.common.common.journal_hierarchy, bums.common.common.journal_redesign, bums.common.common.linked_deals_new_filters, bums.common.conference.conference_feature, bums.common.conference.conference_hint_feature, bums.common.conference.conference_use_webinar_feature, bums.common.facebook.facebook_integration, bums.common.carrot_quest, bums.common.carrot_quest_spa_init, bums.common.collapsible_main_menu, bums.enabled_desktop_switcher, bums.common.component_document_card, bums.force_switch_document_card_to_react, bums.common.component_document_list, bums.force_switch_document_list_to_react, bums.common.component_project_card, bums.task_card_component, bums.force_switch_task_card_to_react, bums.task_list_component, bums.force_switch_task_list_to_react, bums.common.component_todo_card, bums.force_switch_todo_card_to_react, bums.common.component_todo_list, bums.force_switch_todo_list_to_react, bums.trade_card_component, bums.force_switch_trade_card_to_react, bums.trade_list_component, bums.force_switch_trade_list_to_react, bums.common.da_data_suggestion_api, bums.common.email_template, bums.common.feedback_send, bums.common.file_ext_field, bums.common.firebase, bums.common.history_diff_view, bums.common.inline_tables_edit, bums.common.internal_link_target_self, bums.common.list_filters_hide, bums.common.lite_mobile, bums.common.megaplan_outsource_feature, bums.common.mentions, bums.common.messenger_tabs_in_journal, bums.common.mobile_app_promo, bums.common.new_editor, bums.common.new_main_menu, bums.common.new_system_filters, bums.common.ny_theme2022, bums.common.ny_theme24, bums.common.on_boarding_tutorial, bums.common.onboarding_demo_accounts, bums.common.onboarding_first_configure_show, bums.common.onboarding_hint, bums.common.present_on_informer_panel, bums.common.prod_help_feature, bums.common.product_quest_context_help, bums.common.product_quest_feature, bums.common.product_quest_feedback, bums.common.product_quest_icon, bums.common.product_quest_rating, bums.common.profile_and_menu_settings, bums.common.program_trigger_editor_new, bums.common.promo, bums.common.registration_with_email, bums.common.restore_modal_form, bums.common.setting_mail_list, bums.common.setting_module, bums.common.stroj_help_feature, bums.common.task_kanban_todo_list, bums.issue.form_field_select, bums.common.todo_mini_card_date_picker, bums.common.todo_one_line_list, bums.common.unsupported_browser_popup, bums.common.upgrades_module, bums.common.user_flow, bums.common.web_push_notifications, bums.common.webvisor, bums.common.workspaces, bums.common.yandex_metrika, bums.common.promo.on_boarding_rating, bums.common.item.preset_filters, bums.common.telegram.telegram, bums.common.wazzup.instagram, bums.common.wazzup.wazzup, bums.common.wazzup.wazzup_api_key_connect, bums.company_card_component, bums.force_switch_crm_card_to_react_upd, bums.crm_list_component, bums.force_switch_crm_list_to_react, bums.crm.contacts_for_contractor_human, bums.crm.duplicate_notifier, bums.crm.has_duplicate_filter, bums.crm.merge_contractors_in_job, bums.crm.new_crm_filters, bums.discuss.component_topic_list, bums.discuss.mail_discuss_feature, bums.discuss.personal_megamail, bums.discuss.subordinates_chats_feature, bums.doc.only_office, bums.doc.only_office_file_editor, bums.integration.application_card_view, bums.integration.application_new_interface, bums.integration.custom_lead_form, bums.integration.integration_widget_interface, bums.integration.uis_promo, bums.invoice.offer_catalog_feature, bums.invoice.offer_consignments_feature, bums.report.ellipsis_in_complex_report_cells, bums.report.forbid_collapse_groups_setting, bums.report.periodic_grouping, bums.settings.account_auto_payment, bums.settings.allow_to_delete_account, bums.settings.files_table, bums.settings.voximplant, bums.spaces.tariff_feature.onboarding, bums.staff.change_chief_and_subordinate, bums.staff.check_can_login_employees_count, bums.staff.component_employee, bums.staff.component_employee_card, bums.force_switch_employee_card_to_react, bums.force_switch_employee_to_react, bums.staff.custom_fields, bums.staff.effectiveness_chart, bums.staff.flexible_home_module, bums.staff.freelancer, bums.staff.show_user_online_productivity, bums.task.create_sub_tasks_from_template_in_job, bums.task.issue_kpi_feature, bums.task.new_task_filters, bums.task.show_effectiveness_in_form, bums.task.task_kanban_view, bums.task.top_roles, bums.time.calendar_new_integration, bums.time.calendar_without_participants_and_busy_participants, bums.time.todo_relations_in_form, bums.trade.card_header_status_change, bums.trade.create_deal_operation, bums.trade.deal_card_with_tabs, bums.trade.deal_main_card_setting, bums.trade.deal_preset_master, bums.trade.show_kanban_in_deals, bums.trade.switch_both_list_and_card, logic.stm.b_p_m_module, logic.stm.linked_business_processes_names, logic.stm.processes_names_settings, sdf.event.recomet, sdf.file.edit_on_click, sdf.file.enable_file_delete, sdf.smartsearch.smart_search_feature, sdf.smartsearch.smart_search_react_feature

Уникальное название фичи

isAvailable boolean

Включена ли фича (в момент запроса)

isTestDriveAvailable boolean

Доступен ли тест драйв для фичи

isEnabledForUser boolean

Включена ли фича для текущего пользователя

bums\common\common\api\v03\Entity\FieldChange

Описание

Изменение конретного поляЕсли поле field хранит массив BaseValue или BaseEntity, то вместо одного FieldChangeс oldValue = старое значение массива и newValue = новое значение массива в Changeset будет два FieldChange.Один FieldChange с oldValue = null и newValue - массивом только добавленных сущностейВторой FieldChange с oldValue - массивом удаленных сущностей и newValue = null

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FieldChange
description string

timeCreated DateTime

oldValue any

Старое значение поля field.

newValue any

field string

changedEntity Объединение
Возможные типы:
BaseEntity

BaseValue

Объект который был изменен

author Объединение
Возможные типы:
Employee

ContractorHuman

EntityDescription

ContractorCompany

Group

bums\common\common\api\v03\Entity\File

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен File
name* string

Название файла вместе с расширением

extension* string

Расширение

size* integer

Размер файла в байтах

path* string

Путь к файлу для скачивания и/или отображения

error string

Текст ошибки

subject BaseEntity

Родительский объект

mimeType string

MIME-тип

timeCreated DateTime

Время создания

aspectRatio number

Соотношение сторон

thumbnail string

Миниатюра

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_share, act_edit

Список возможных действий над файлом

metadata Объединение
Возможные типы:
ImageFileMetadata

AudioFileMetadata

id string

Идентификатор

bums\common\common\api\v03\Entity\FileGroup

Описание

Группа файлов

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FileGroup
name string

Название

children Коллекция

Возможные типы: File

Массив файлов

childrenCount integer

Количество файлов в группе

id string

Идентификатор

bums\common\common\api\v03\Entity\FilterConfig

Описание

Конфигурация фильтра. Содержит список условий

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterConfig
termGroup* FilterTermGroup

Группа условий фильтра

filterId Объединение
Возможные типы:
string

integer

Идентификатор фильтра

bums\common\common\api\v03\Entity\FilterExport

Описание

Экспорт по фильтрам

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterExport
file File

bums\common\common\api\v03\Entity\FilterGroup

Описание

Группа фильтров

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterGroup
name string

Название

type* string

Возможные варианты: task, crm, trade, employee, todo, offer, consignment, warehouse

Тип

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

filtersOrder Коллекция

Возможные типы: string

Сохранённый порядок фильтров в группе.

expanded boolean

Раскрытость группы

program Program

Схема сделки

id string

Идентификатор

bums\common\common\api\v03\Entity\FilterTermGroup

Описание

Группа условий фильтра, которые объединяются через and или or

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermGroup
join* string

Возможные варианты: and, or

Строка условия

terms* Коллекция

Возможные типы:

FilterTermBool

FilterTermDate

FilterTermEnum

FilterTermFormula

FilterTermNumber

FilterTermRef

FilterTermString

Условие фильтра

bums\common\common\api\v03\Entity\FilterTerm\FilterTermBool

Описание

Определение фильтра да/нет.

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermBool
value* boolean

comparison string

Возможные варианты: equals

refine FilterTermGroup

Дополнительное условие фильтрации

field* string

Имя поля, к которому применяется условие

bums\common\common\api\v03\Entity\FilterTerm\FilterTermDate

Описание

Фильтрация по дате

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermDate
comparison string

Возможные варианты: equals, not_equals

value Объединение
Возможные типы:
DateOnly

IntervalDates

IntervalTime

FilterTermDateValue

refine FilterTermGroup

Дополнительное условие фильтрации

field* string

Имя поля, к которому применяется условие

bums\common\common\api\v03\Entity\FilterTerm\FilterTermDateValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermDateValue
mode string

Возможные варианты: past, current, next, before, before_or_equal, later, later_or_equal, later_on, before_on, later_from, before_from

Режим сравнения

unit string

Возможные варианты: second, minute, hour, day, workDay, week, month, quarter, year

Единица измерения

value Объединение
Возможные типы:
DateOnly

IntervalNumbers

integer

Значение

bums\common\common\api\v03\Entity\FilterTerm\FilterTermEnum

Описание

Фильтрация по полю с выбором

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermEnum
comparison string

Возможные варианты: equals, not_equals

value Коллекция

Возможные типы: string

refine FilterTermGroup

Дополнительное условие фильтрации

field* string

Имя поля, к которому применяется условие

bums\common\common\api\v03\Entity\FilterTerm\FilterTermFormula

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermFormula
formula string

refine FilterTermGroup

Дополнительное условие фильтрации

comparison string

Возможные варианты: equals, not_equals, less, less_eq, more, more_eq, interval, one_of, contains, not_contains

value Объединение
Возможные типы:
integer

number

IntervalNumbers

string

bums\common\common\api\v03\Entity\FilterTerm\FilterTermNumber

Описание

Определение фильтра по числу.

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermNumber
refine FilterTermGroup

Дополнительное условие фильтрации

field* string

Имя поля, к которому применяется условие

comparison string

Возможные варианты: equals, not_equals, less, less_eq, more, more_eq, interval, one_of, contains, not_contains

value Объединение
Возможные типы:
integer

number

IntervalNumbers

string

bums\common\common\api\v03\Entity\FilterTerm\FilterTermRef

Описание

Фильтрация по полю с сущностью

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermRef
comparison string

Возможные варианты: equals, not_equals

value Коллекция

Возможные типы:

BaseEntity

Variable

refine FilterTermGroup

Дополнительное условие фильтрации

field* string

Имя поля, к которому применяется условие

bums\common\common\api\v03\Entity\FilterTerm\FilterTermString

Описание

Фильтрация по строке

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterTermString
comparison string

Возможные варианты: equals, not_equals, contains, not_contains, starts_with

value string

refine FilterTermGroup

Дополнительное условие фильтрации

field* string

Имя поля, к которому применяется условие

bums\common\common\api\v03\Entity\FilterUserFieldsRequest

Описание

Class FilterUserFieldsRequestТело POST запроса /{entityType}Filter/{id}/userFields

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FilterUserFieldsRequest
userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Поьзовательская сортировка

bums\common\common\api\v03\Entity\Filter\ConsignmentFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ConsignmentFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\CrmFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CrmFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\CustomCrmFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomCrmFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\DocFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DocFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\EmployeeFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmployeeFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\FileStorageFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FileStorageFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\IntegrationFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IntegrationFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\InvoiceFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InvoiceFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\OfferFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\ReportFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\TaskFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TaskFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\TodoFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\TradeFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TradeFilter
program Program

kanbanColumns Коллекция

Возможные типы: KanbanColumnInfo

kanbanColumnsCount integer

sortField KanbanSortField

parent TradeFilter

viewMode string

Возможные варианты: list, kanban

title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Filter\WarehouseFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WarehouseFilter
title string

Название

count integer

Количество

href string

Ссылка

shared boolean

Общий

owner Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Владелец фильтра

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный фильтр

visibleForCount integer

Количество тех, кому виден данный фильтр

config FilterConfig

Конфигурация фильтра

availableActions Коллекция

Возможные типы: string

Возможные варианты: edit

Доступные действия

defaultFields Коллекция

Возможные типы: string

Исходный список полей фильтра

defaultSortby Коллекция

Возможные типы: SortField

Исходная сортировка полей

defaultSortbyCount integer

userFields Коллекция

Возможные типы: string

Пользовательский список полей фильтра

userSortby Коллекция

Возможные типы: SortField

Пользовательская сортировка

userSortbyCount integer

group FilterGroup

Группа фильтров

expanded boolean

Расширенный

id string

Идентификатор

bums\common\common\api\v03\Entity\Group

Описание

Группа других сущностейИспользуется для объединения сущностей по какому то признаку

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Group
name string

Название группы

children Коллекция

Возможные типы: BaseEntity

Сущности группы

childrenCount integer

Количество сущностей в группе

id string

Идентификатор

bums\common\common\api\v03\Entity\Holiday

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Holiday
name string

id string

Идентификатор

bums\common\common\api\v03\Entity\HolidayDay

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен HolidayDay
date DateOnly

holiday Holiday

id string

Идентификатор

bums\common\common\api\v03\Entity\HolidaysProvider

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен HolidaysProvider
name string

selected boolean

id string

Идентификатор

bums\common\common\api\v03\Entity\ImageFileMetadata

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ImageFileMetadata
width integer

height integer

bums\common\common\api\v03\Entity\ImageVariable

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ImageVariable
value File

name string

bums\common\common\api\v03\Entity\IntegrationInfo

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IntegrationInfo
name string

identifier string

isIntegrationEnabled boolean

isWidgetEnabled boolean

bums\common\common\api\v03\Entity\Interaction

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Interaction
user Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Сотрудник или клиент

time DateTime

Дата первого взаимодействия

lastTime DateTime

Дата последнего взаимодействия

action string

Действие

model BaseEntity

Сущность

id string

Идентификатор

bums\common\common\api\v03\Entity\InteractionCounter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InteractionCounter
action string

Действие

count integer

Действие количетсво

bums\common\common\api\v03\Entity\IntervalDates

Описание

Интервал дат

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IntervalDates
from DateOnly

Дата начала

to DateOnly

Дата завершения

bums\common\common\api\v03\Entity\IntervalNumbers

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IntervalNumbers
from Объединение
Возможные типы:
integer

number

to Объединение
Возможные типы:
integer

number

bums\common\common\api\v03\Entity\IntervalTime

Описание

Временной интервал

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IntervalTime
from DateTime

Дата начала

to DateTime

Дата завершения

bums\common\common\api\v03\Entity\IssueExtraFieldsLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IssueExtraFieldsLayout
showEmptyFields boolean

collapsedGroups Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\IssuesTableLayout

Описание

Настройка размещения блока с задачами

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IssuesTableLayout
viewMode string

Возможные варианты: list, diagram

diagramScale string

Возможные варианты: day, week, month, quarter, year

sortField SortField

fields Коллекция

Возможные типы: string

filters Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\JournalLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен JournalLayout
selectedTab string

Возможные варианты: journal, files, messages, calls, hidden, comments, whatsapp, telegram, instagram, mail

historyReverse boolean

commentsAutoScrollDisabled boolean

deletedCommentsVisibility boolean

worktimeActive boolean

selectedFilters Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\KanbanSortField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен KanbanSortField
field Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

sortedValues Коллекция

Возможные типы: string

bums\common\common\api\v03\Entity\Language

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Language
langGroup string

id string

Идентификатор

bums\common\common\api\v03\Entity\LayoutSetting

Описание

Настройка размещения блоков макета карточек

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LayoutSetting
top Коллекция

Возможные типы: LayoutSettingBlock

left Коллекция

Возможные типы: LayoutSettingBlock

center Коллекция

Возможные типы: LayoutSettingBlock

right Коллекция

Возможные типы: LayoutSettingBlock

bottom Коллекция

Возможные типы: LayoutSettingBlock

bums\common\common\api\v03\Entity\LayoutSettingBlock

Описание

Настройка блока внутри карточки клиента

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LayoutSettingBlock
name* string

hidden boolean

collapsed boolean

fixed boolean

bums\common\common\api\v03\Entity\MailSmtpEmailError

Описание

Сущность уведомления об ошибке отправки письма через интегрированную почту

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MailSmtpEmailError
id string

Идентификатор

bums\common\common\api\v03\Entity\MainFieldsLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MainFieldsLayout
fields Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\MassAction\CreateConsignmentMassActionResult

Описание

Результат массового действия создания накладной

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateConsignmentMassActionResult
consignment Consignment

succeededCount integer

failedCount integer

bums\common\common\api\v03\Entity\MassAction\MassActionAppendCollection

Описание

Класс массового добавления сущностей в поле

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionAppendCollection
value* Коллекция

Возможные типы: BaseEntity

field* string

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionApplyTrigger

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionApplyTrigger
trigger* ProgramTrigger

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionChangeProgramState

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionChangeProgramState
state* ProgramState

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionCreateConsignment

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionCreateConsignment
filter OfferFilter

Фильтр, по которому можно получить список сущностей

type* string

Возможные варианты: income, expense

consignment Consignment

warehouse Warehouse

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionDelete

Описание

Класс массового удаления сущностей

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionDelete
deleteRequest DeleteActionRequest

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionDoAction

Описание

Класс массового запуска экшена

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionDoAction
value* string

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionEditField

Описание

Класс массового изменения одного поля у сущностей

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionEditField
field* string

value* any

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionEntitiesToFilters

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionEntitiesToFilters
mode string

Возможные варианты: include, exclude

Режим массового действия

toFilters* Коллекция

Возможные типы:

ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, к которому применяется действие

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionLinkEntities

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionLinkEntities
subject* BaseEntity

Сущность к которой прикрепляем

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionResult

Описание

Результат массового действия

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionResult
entity BaseEntity

isSucceed boolean

message string

bums\common\common\api\v03\Entity\MassAction\MassActionSubtractCollection

Описание

Класс массового удаления сущностей из поля

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionSubtractCollection
value* Коллекция

Возможные типы: BaseEntity

field* string

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MassAction\MassActionUnlinkEntities

Описание

Массовое открепление сущностей

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MassActionUnlinkEntities
subject* BaseEntity

Сущность от которой открепляем

filter Объединение
Возможные типы:
ConsignmentFilter

CrmFilter

CustomCrmFilter

DocFilter

EmployeeFilter

FileStorageFilter

IntegrationFilter

InvoiceFilter

OfferFilter

ReportFilter

TaskFilter

TodoFilter

TradeFilter

WarehouseFilter

Фильтр, по которому можно получить список сущностей

query string

Запрос введенный в поле Найти в Мегаплане

queryFields Коллекция

Возможные типы: string

Поля, по которым идет поиск

entities Коллекция

Возможные типы: BaseEntity

Список сущностей

excludedEntities Коллекция

Возможные типы: BaseEntity

Список игнорированных сущностей

baseOn BaseEntity

Связная сущность

withNotifications boolean

Отключить уведмоления для имзененных сущностей

bums\common\common\api\v03\Entity\MenuItem

Описание

Элемент главного меню Мегаплана

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MenuItem
url string

frameUrl string

id string

title string

icon File

showForUsers Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден данный пункт меню

showForUsersCount integer

blank boolean

isActive boolean

parent MenuItem

subMenu Коллекция

Возможные типы: MenuItem

subMenuCount integer

color UserColor

urlAliases Коллекция

Возможные типы: string

isExternal boolean

isEnabled boolean

isCustom boolean

bums\common\common\api\v03\Entity\Metro

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Metro
city* City

name* string

Название

id string

Идентификатор

bums\common\common\api\v03\Entity\Module

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Module
availableInPaidVersionOnly boolean

Модуль будет доступен в платной версии Мегаплана

id string

Идентификатор

bums\common\common\api\v03\Entity\NewFilterSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NewFilterSettings
fields* Коллекция

Возможные типы: TableField

kanbanColumns Коллекция

Возможные типы: KanbanColumnInfo

bums\common\common\api\v03\Entity\NewMessage

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NewMessage
content string

timeCreated DateTime

id string

Идентификатор

bums\common\common\api\v03\Entity\News

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен News
title string

date string

bums\common\common\api\v03\Entity\Notification

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Notification
type string

time DateTime

content string

sender Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

size integer

subject BaseEntity

isActive boolean

isMention boolean

isHistoryLog boolean

id string

Идентификатор

bums\common\common\api\v03\Entity\NotificationType

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NotificationType
name string

Название типа

id string

Идентификатор

bums\common\common\api\v03\Entity\OfferExtraFieldsLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferExtraFieldsLayout
hiddenGroups Коллекция

Возможные типы: string

fixedFields Коллекция

Возможные типы: string

collapsedFixedGroups Коллекция

Возможные типы: string

collapsedGroups Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\OnBoardingProgramFirstLoginTutorial

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OnBoardingProgramFirstLoginTutorial
step string

bums\common\common\api\v03\Entity\OnBoardingProgramTaskCardTutorial

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OnBoardingProgramTaskCardTutorial
step string

bums\common\common\api\v03\Entity\OnBoardingProgramTutorial

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OnBoardingProgramTutorial
step string

bums\common\common\api\v03\Entity\OnboardingPollResult

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OnboardingPollResult
forWhom string

Возможные варианты: forMyself, forTeam, forCompany, forDepartment

chooseIndustry string

chooseRole string

Возможные варианты: director, manager, employee

howManyEmployees string

Возможные варианты: upTo5People, from6To15People, moreThan15People

experienceWithCRM string

Возможные варианты: yesIUseItNow, yesImplementedEarlier, introductoryOnly, no

nameOfYourCompany string

pollWasCanceled boolean

comment string

isCustomIndustry boolean

isCustomNameOfYourCompany boolean

bums\common\common\api\v03\Entity\OpenGraph

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OpenGraph
title string

siteName string

description string

imageUrl string

bums\common\common\api\v03\Entity\ParseHints

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ParseHints
categoryId string

categoryHrSelected string

responsibleId string

responsibleHrSelected string

bums\common\common\api\v03\Entity\ParsedItem

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ParsedItem
placeholder string

text string

target Объединение
Возможные типы:
DateTime

IntervalTime

IntervalDates

BaseEntity

bums\common\common\api\v03\Entity\ParsedStruct

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ParsedStruct
text string

textWithPlaceholder string

parsedItems Коллекция

Возможные типы: ParsedItem

bums\common\common\api\v03\Entity\Participant

Описание

Участник дела

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Participant
subject* Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Сущность участника

status string

Возможные варианты: accepted, requested, rejected

Статус

contactInfo Коллекция

Возможные типы: ContactInfo

Массив контактной информации

contactInfoCount integer

Количество элементов в массиве с контактной информации

id string

Идентификатор

bums\common\common\api\v03\Entity\Place

Описание

Место проведения события

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Place
name string

Название места

id string

Идентификатор

bums\common\common\api\v03\Entity\PreparedCommentTemplateFields

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PreparedCommentTemplateFields
subject string

content string

bums\common\common\api\v03\Entity\ProductQuest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProductQuest
id string

Возможные варианты: initial

items Коллекция

Возможные типы: ProductQuestItem

itemsCount integer

completedItemsCount integer

uncompletedItemsCount integer

bums\common\common\api\v03\Entity\ProductQuestItem

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProductQuestItem
id string

Возможные варианты: registred_in_megaplan, create_employee, create_task, create_contractor, edit_main_menu

completed boolean

bums\common\common\api\v03\Entity\ReadInteraction

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReadInteraction
isMain boolean

user Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Сотрудник или клиент

time DateTime

Дата первого взаимодействия

lastTime DateTime

Дата последнего взаимодействия

action string

Действие

model BaseEntity

Сущность

id string

Идентификатор

Описание

Связанные ссылки на внутренние ресурсы

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RelationLink
placeholder string

Текст подсказки

relationType string

Тип связи

representation string

Представление

data string

Данные

subject* BaseEntity

Базовая сущность

origin string

Оригинал

target BaseEntity

Целевая сущность

isTargetVisible boolean

Видимость цели

isSubjectReadableForMentionUser boolean

Читаема ли сущность для упомянутого пользователя

metadata RelationLinkMetadata

id string

Идентификатор

bums\common\common\api\v03\Entity\RelationLinkMetadata

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RelationLinkMetadata
data string

bums\common\common\api\v03\Entity\Reminder

Описание

Напоминания

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Reminder
subject Объединение
Возможные типы:
Todo

Milestone

Сущность

type string

Тип

transport* string

Транспорт отправки напоминания

timeBefore DateInterval

Временной интервал до начала события

recipient Объединение
Возможные типы:
Employee

ContractorHuman

Получатель

timeCreated DateTime

Время создания

isActive boolean

Активно

bums\common\common\api\v03\Entity\ResourceValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ResourceValue
planned number

actual number

bums\common\common\api\v03\Entity\Schedule

Описание

Событие

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Schedule
startDate Объединение
Возможные типы:
DateTime

DateOnly

Дата начала

endDate DateOnly

Дата окончания

repetitions integer

Количество повторений

interval* string

Возможные варианты: day, week, month, year

Временной интервал

each integer

Каждый период

workDaysOnly boolean

Только по рабочим дням

weekDays Коллекция

Возможные типы: integer

Будние дни

week integer

Номер недели

hour integer

Часы

minute integer

Минуты

month integer

Номер месяца

day integer

Номер дня

id string

Идентификатор

bums\common\common\api\v03\Entity\SearchFoundField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SearchFoundField
hrName string

value string

subModel BaseEntity

bums\common\common\api\v03\Entity\SearchGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SearchGroup
type string

totalItemsCount integer

items Коллекция

Возможные типы: BaseEntity

bums\common\common\api\v03\Entity\SearchGroupCounter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SearchGroupCounter
type string

count integer

bums\common\common\api\v03\Entity\SearchResult

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SearchResult
model BaseEntity

fields Коллекция

Возможные типы: SearchFoundField

title string

bums\common\common\api\v03\Entity\SelectableArrayVariable

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SelectableArrayVariable
variants Коллекция

Возможные типы: SelectableArrayVariant

basePath string

selectedIndex integer

name string

value string

bums\common\common\api\v03\Entity\SelectableArrayVariant

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SelectableArrayVariant
value Объединение
Возможные типы:
string

ImageVariable

valueModel BaseEntity

variable SelectableArrayVariable

key integer

bums\common\common\api\v03\Entity\ShareUrl

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ShareUrl
link string

id string

Идентификатор

bums\common\common\api\v03\Entity\ShiftDate

Описание

Сдвиг дат

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ShiftDate
days integer

Дни

hours integer

Часы

minutes integer

Минуты

isWorkDays boolean

Расчет в рабочих днях

bums\common\common\api\v03\Entity\Signature

Описание

Подпись

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Signature
name string

position string

image Коллекция

Возможные типы: File

imageCount integer

id string

Идентификатор

bums\common\common\api\v03\Entity\SortField

Описание

Конфигурация поля сортировки

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SortField
fieldName* string

Имя поля по которому нужно сортировать

desc boolean

Сортировать по убыванию

bums\common\common\api\v03\Entity\Statistic

Описание

Статистика аккаунта Мегаплана

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Statistic
commentCount integer

Количество комментариев в журнале. Общее число

topCommentators Коллекция

Возможные типы: any

Количество комментариев в журнале. тройка победителей

myComments integer

Количество комментариев в журнале. Число юзера, который смотрит статистику

taskCount integer

Количество задач, закрытых в году. Общее число

topWorkers Коллекция

Возможные типы: any

Количество задач, закрытых в году. Тройка победителей,

myTasks integer

Количество задач, закрытых юзером, который смотрит статистику

dealCount integer

Количество завершенных процессов (сделок) по аккаунту. Общее число по всему аккаунту

likeCount integer

Количество отметок "нравится" во всей системе.

topLikers Коллекция

Возможные типы: any

Количество отметок "нравится": тройка победителей

myLikes integer

Количество отметок "нравится" юзера, который смотрит статистику

chatMessageCount integer

Количество сообщений в чатах. Общее число

topChatMessages Коллекция

Возможные типы: any

Количество сообщений в чатах. Общее число, тройка победителей

myChatMessges integer

Количество сообщений в чатах. Число юзера, который смотрит статистику

avgAllUsersOnline number

Среднее время в секундах, проведенное в системе

topUserOnline Коллекция

Возможные типы: any

Среднее время в секундах, проведенное в системе (тройка победителей)

myAvgOnline number

Среднее время в секундах, проведенное в системе текущего пользователя

consignmentCount integer

Количество операций по накладным.

myConsignmentCount integer

Количество операций по накладным текущего пользователя.

topConsignmentCount Коллекция

Возможные типы: any

Количество операций по накладным (тройка победителей).

mentionCount integer

Количество упоминаний сотрудников в году. Всего

topMention Коллекция

Возможные типы: any

Количество упоминаний сотрудников в году. Топ 3

myMentionCount integer

Количество упоминаний сотрудников в году. Текущий пользователь.

filesSize integer

Количество документов (объем в байтах), загруженных в хранилище. Всего

topFilesSize Коллекция

Возможные типы: any

Количество документов (объем в байтах), загруженных в хранилище. Топ 3

myFilesSize integer

Количество документов (объем в байтах), загруженных в хранилище. Текущий пользователь.

calendarItems integer

Количество дел, поставленных в календаре. Всего

topCalendarItems Коллекция

Возможные типы: any

Количество дел, поставленных в календаре. Топ 3

myCalendarItems integer

Количество дел, поставленных в календаре. Текущий пользователь.

bums\common\common\api\v03\Entity\Support\FeedbackRequest

Описание

Энтити отзыва

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FeedbackRequest
text string

Текст отзыва

attaches Коллекция

Возможные типы: File

Прикрепленные файлы

userAgent string

referer string

resolution string

typeTicket string

email string

bums\common\common\api\v03\Entity\TableField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TableField
fieldName* string

Имя поля

width string

Ширина

bums\common\common\api\v03\Entity\TableLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TableLayout
sortField SortField

fields Коллекция

Возможные типы: string

filters Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\Tag

Описание

Метки

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Tag
name* string

Название

user Employee

Сотрудник

canEdit boolean

Можно редактировать

isGlobal boolean

Глобальная

id string

Идентификатор

bums\common\common\api\v03\Entity\TaskDiagramInfo

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TaskDiagramInfo
minDate DateTime

maxDate DateTime

bums\common\common\api\v03\Entity\TodoMiniCard

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoMiniCard
mainField string

secondaryField1 string

secondaryField2 string

showFavourite boolean

showParticipants boolean

showCategory boolean

bums\common\common\api\v03\Entity\TodosLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodosLayout
filters Коллекция

Возможные типы: string

miniCard TodoMiniCard

sort string

name* string

bums\common\common\api\v03\Entity\TreeNode

Описание

Узел дерева иерархического представления списка

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TreeNode
value BaseEntity

Tree element value (representable)

auxiliary boolean

True if current value is only to show hierarсhy in correct order, but the value itselfis not right for currently filtered tree

childrenCount integer

Amount of children of current filter

children Коллекция

Возможные типы: TreeNode

Filtered first page of children of the node. Can be filled to optimize tree loading for an auxiliary node

expanded boolean

Is current level was previously expanded by userTo save expanding state of the node, post a TreeNode to /task/expand

parent TreeNode

Родитель

id string

Идентификатор

bums\common\common\api\v03\Entity\UserColor

Описание

Class UserColorКастомного цвет заданный пользователем

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UserColor
hexColor string

Значение цвета в 16-ричном формате

bums\common\common\api\v03\Entity\UserInterfaceLayout

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UserInterfaceLayout
desktop LayoutSetting

tablet LayoutSetting

cards Коллекция

Возможные типы: any

cardsCount integer

id string

Идентификатор

bums\common\common\api\v03\Entity\UserSetting

Описание

настройки пользователя

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UserSetting
value any

id string

Идентификатор

bums\common\common\api\v03\Entity\Variable

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Variable
name string

value string

bums\common\common\api\v03\Entity\WarehouseExtraFieldsLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WarehouseExtraFieldsLayout
hiddenGroups Коллекция

Возможные типы: string

fixedFields Коллекция

Возможные типы: string

collapsedFixedGroups Коллекция

Возможные типы: string

collapsedGroups Коллекция

Возможные типы: string

name* string

bums\common\common\api\v03\Entity\WeekendDay

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WeekendDay
name string

selected boolean

key string

bums\common\conference\api\v03\Entity\ConferenceRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ConferenceRequest
entity Объединение
Возможные типы:
Topic

Todo

id string

Идентификатор

bums\common\conference\api\v03\Entity\ConferenceRoomAuth

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ConferenceRoomAuth
sessionId string

Идентификатор сессии

token string

url string

roomId integer

secret string

id string

Идентификатор

bums\common\conference\api\v03\Entity\ConferenceSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ConferenceSettings
type string

Возможные варианты: conference, webinar

speakers Коллекция

Возможные типы: Employee

presentationFile File

bums\common\facebook\api\v03\Entity\FacebookMessage

Описание

Сообщение из Facebook (личная переписка или комментарий к посту)

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FacebookMessage
messageId string

Идентификатор сообщения

timeSent DateTime

Время отправки

from string

От кого

to string

Адресат

text string

Текст сообщения

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

isOutgoing boolean

Исходящее

deliveryStatus string

Возможные варианты: initial, sent, not_sent, delivered, not_delivered, read

Статус доставки

timeCreated DateTime

Время создания

convertedTo Объединение
Возможные типы:
Comment

Task

Project

ContractorHuman

ContractorCompany

Deal

Topic

Конвертируется в сущность

parent Объединение
Возможные типы:
Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childs Коллекция

Возможные типы:

Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childsCount integer

deepChildsCount integer

lastErrorMessage string

id string

Идентификатор

bums\common\facebook\api\v03\Entity\FacebookPage

Описание

Страница Facebook

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FacebookPage
name string

Название

subject Program

Схема сделки

id string

Идентификатор

bums\common\facebook\api\v03\Entity\FacebookTransport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FacebookTransport
page FacebookPage

bums\common\hardcode\api\v03\Entity\CustomerData

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomerData
phone any

bums\common\hardcode\api\v03\Entity\CustomerMessage

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomerMessage
subject string

Тема письма заказа

bums\common\import\api\v03\Entity\ImportCell

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ImportCell
hrValue string

columnIndex integer

validationCode string

Возможные варианты: ok, ignore, error, column_unselected

validationError string

Сообщение о ошибке

bums\common\import\api\v03\Entity\ImportColumn

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ImportColumn
fieldName string

hrName string

isRequired boolean

index integer

id string

Идентификатор

bums\common\import\api\v03\Entity\ImportRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ImportRow
index integer

included boolean

cells Коллекция

Возможные типы: ImportCell

cellsCount integer

status string

Возможные варианты: ok, error

errorMessage string

isInvalidated boolean

Все ячейки строки имеют статус ignore или error или column_unselected. Строка не может быть загружена.

id string

Идентификатор

bums\common\mail\api\v03\Entity\Imap

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Imap
imapConfig MailServerConfig

smtpConfig MailServerConfig

email string

E-mail адрес

footer string

incomingEmailMode string

Возможные варианты: email, deal

receivePrivateEmail boolean

program Program

programState ProgramState

isDefault boolean

Используется по умолчанию

imapStatus string

Возможные варианты: disabled, error, unknown, enabled

smtpStatus string

Возможные варианты: disabled, error, unknown, enabled

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому доступно

visibleForCount integer

userCreated Employee

expandedVisibleForCount integer

разворачивает группы для подсчета участников

id string

Идентификатор

bums\common\mail\api\v03\Entity\MailServerConfig

Описание

Настройки почтового сервера imap или smtp

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MailServerConfig
type string

Тип(smtp, imap)

host string

Хост

port integer

Порт

ssl boolean

Использование SSL

oauth2 boolean

Использование oauth2

login string

password string

bums\common\mail\api\v03\Entity\Smtp

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Smtp
email string

E-mail адрес

isDefault boolean

Используется по умолчанию

footer string

Футер письма

serverConfig MailServerConfig

Конфигурация почтового сервера

visibleFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому виден

visibleForCount integer

subject Объединение
Возможные типы:
Employee

Program

К чему прикреплена

status string

Возможные варианты: unknown, enabled, error, disabled

userCreated Employee

id string

Идентификатор

bums\common\megamail\api\v03\Entity\Megamail

Описание

Сущность отправки писем

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Megamail
email string

E-mail адрес

isPersonal boolean

Персональный

id string

Идентификатор

bums\common\messenger\api\v03\Entity\Messenger

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Messenger
name* string

messageSendUri string

type MessengerType

channels Коллекция

Возможные типы: MessengerChannel

channelsCount integer

id string

Идентификатор

bums\common\messenger\api\v03\Entity\MessengerChannel

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MessengerChannel
messenger* Messenger

identifier* string

name* string

comment string

isActive boolean

errorText string

responsibles Коллекция

Возможные типы: Employee

responsiblesCount integer

nextResponsibleStrategy string

Возможные варианты: user_set_next, user_set_online

program Program

id string

Идентификатор

bums\common\messenger\api\v03\Entity\MessengerTransportConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MessengerTransportConfig
from MessengerChannel

to string

bums\common\messenger\api\v03\Entity\MessengerType

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MessengerType
type string

masterType string

Возможные варианты: whatsapp, telegram, instagram, facebook, skype, icq, jabber, unknown

id string

Идентификатор

bums\common\productNews\api\v03\Entity\ProductNews

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProductNews
content string

title string

date string

img string

newsId string

link string

bums\common\stat\api\v03\Entity\UserOnlineSession

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UserOnlineSession
user Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Пользователь

start DateTime

Начало сессии

finish DateTime

Конец сессии

type string

Возможные варианты: common, mobile

Тип сессии

id string

Идентификатор

bums\common\telegram\api\v03\Entity\TelegramChannel

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TelegramChannel
id string

Идентификатор

name string

phone string

comment string

bums\common\telegram\api\v03\Entity\TelegramMessage

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TelegramMessage
id string

Идентификатор

from string

От кого

to string

Адресат

messageId string

Идентификатор сообщения

timeSent DateTime

Время отправки

text string

Текст сообщения

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

isOutgoing boolean

Исходящее

deliveryStatus string

Возможные варианты: initial, sent, not_sent, delivered, not_delivered, read

Статус доставки

timeCreated DateTime

Время создания

convertedTo Объединение
Возможные типы:
Comment

Task

Project

ContractorHuman

ContractorCompany

Deal

Topic

Конвертируется в сущность

parent Объединение
Возможные типы:
Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childs Коллекция

Возможные типы:

Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childsCount integer

deepChildsCount integer

lastErrorMessage string

bums\common\telegram\api\v03\Entity\TelegramTransportConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TelegramTransportConfig
channel* TelegramChannel

to* ContactInfo

bums\common\wazzup\api\v03\Entity\InstagramMessage

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InstagramMessage
id string

Идентификатор

from string

От кого

to string

Адресат

messageId string

Идентификатор сообщения

timeSent DateTime

Время отправки

text string

Текст сообщения

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

isOutgoing boolean

Исходящее

deliveryStatus string

Возможные варианты: initial, sent, not_sent, delivered, not_delivered, read

Статус доставки

timeCreated DateTime

Время создания

convertedTo Объединение
Возможные типы:
Comment

Task

Project

ContractorHuman

ContractorCompany

Deal

Topic

Конвертируется в сущность

parent Объединение
Возможные типы:
Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childs Коллекция

Возможные типы:

Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childsCount integer

deepChildsCount integer

lastErrorMessage string

bums\common\wazzup\api\v03\Entity\InstagramTransportConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InstagramTransportConfig
channel* WazzupChannel

to* ContactInfo

bums\common\wazzup\api\v03\Entity\WazzupChannel

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WazzupChannel
id string

Идентификатор

name string

transport string

Возможные варианты: whatsapp, instagram

phone string

state string

Возможные варианты: active, disabled, phoneUnavailable, qr, openElsewhere, notEnoughMoney

comment string

bums\common\wazzup\api\v03\Entity\WhatsappMessage

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WhatsappMessage
id string

Идентификатор

from string

От кого

to string

Адресат

messageId string

Идентификатор сообщения

timeSent DateTime

Время отправки

text string

Текст сообщения

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

isOutgoing boolean

Исходящее

deliveryStatus string

Возможные варианты: initial, sent, not_sent, delivered, not_delivered, read

Статус доставки

timeCreated DateTime

Время создания

convertedTo Объединение
Возможные типы:
Comment

Task

Project

ContractorHuman

ContractorCompany

Deal

Topic

Конвертируется в сущность

parent Объединение
Возможные типы:
Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childs Коллекция

Возможные типы:

Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childsCount integer

deepChildsCount integer

lastErrorMessage string

bums\common\wazzup\api\v03\Entity\WhatsappTransportConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WhatsappTransportConfig
channel* WazzupChannel

to* ContactInfo

bums\crm\api\v03\Entity\ContractorActivityType

Описание

Вид деятельности клиента

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorActivityType
name string

Название

id string

Идентификатор

bums\crm\api\v03\Entity\ContractorAdvertisingWay

Описание

Тип Канал привличения

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorAdvertisingWay
name string

Название

id string

Идентификатор

isDefault boolean

Is it default for current model ?

bums\crm\api\v03\Entity\ContractorImport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorImport
responsibles Коллекция

Возможные типы: Employee

Ответственные

responsiblesCount integer

Количество ответственных

filter CrmFilter

Созданный в итоге фильтр по клиентам

duplicateRows Коллекция

Возможные типы: ImportRow

duplicateRowsCount integer

status string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

previousStatus string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

approveStatusText string

error string

file File

Файл для парсинга

columns Коллекция

Возможные типы: ImportColumn

columnsCount integer

rows Коллекция

Возможные типы: ImportRow

rowsCount integer

includeAllRows boolean

Включает/выключает все строки

validRowsCount integer

Количество отвалидированных (включенных) строк, которые будут сохранены

maxColumnsCountInRows integer

Максимальное количество колонок в строках текущей сессии

includedRows Коллекция

Возможные типы: ImportRow

includedRowsCount integer

invalidatedRows Коллекция

Возможные типы: ImportRow

Строки, которые не будут загружены из-за ошибок

invalidatedRowsCount integer

errorRows Коллекция

Возможные типы: ImportRow

Строки в которых есть критичные и не критичные ошибки, часть из них может быть загружена

errorRowsCount integer

supressNotifications boolean

savedRowsCount integer

Количество сохраненных строк

loadingProgress integer

Прогресс обработки строк в процентах

id string

Идентификатор

bums\crm\api\v03\Entity\ContractorStatus

Описание

Тип статус клиента

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorStatus
name string

Название

id string

Идентификатор

bums\crm\api\v03\Entity\ContractorTypeRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorTypeRights
readShort boolean

bums\crm\api\v03\Entity\ContractorWarning

Описание

Незаполненное поле у клиента

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorWarning
contractor Объединение
Возможные типы:
ContractorCompany

ContractorHuman

id string

Идентификатор

bums\crm\api\v03\Entity\CrmDesktopWidget

Описание

Виджет "Клиенты"

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CrmDesktopWidget
filterId string

posX* integer

posY* integer

title string

Заголовок/название виджета

scale string

Возможные варианты: compact, iconic, spacious, free

Масштаб: компактный, портретный, просторный, свободный

id string

Идентификатор

bums\crm\api\v03\Entity\LeadForm

Описание

Форма лидогенерации

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LeadForm
title string

description string

enabled boolean

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

countPost number

uuid string

id string

Идентификатор

bums\crm\api\v03\Entity\LoyaltyActionLog

Описание

Лог автосценария

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LoyaltyActionLog
loyaltyActionType string

result Объединение
Возможные типы:
FieldChange

SendingTemplate

Todo

id string

Идентификатор

bums\crm\api\v03\Entity\LoyaltyActionLogSet

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LoyaltyActionLogSet
type string

actionLogs Коллекция

Возможные типы: LoyaltyActionLog

actionLogsCount integer

loyaltyProgram LoyaltyProgram

loyaltyProgramRun LoyaltyProgramRun

timeCreated DateTime

id string

Идентификатор

bums\crm\api\v03\Entity\LoyaltyProgram

Описание

Программа лояльности

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LoyaltyProgram
name string

id string

Идентификатор

bums\crm\api\v03\Entity\LoyaltyProgramRun

Описание

Программа лояльности

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LoyaltyProgramRun
userCreated Employee

runType string

Возможные варианты: Automatically, Manually

timeCreated DateTime

id string

Идентификатор

bums\crm\api\v03\Entity\Sending

Описание

Рассылка

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Sending
title string

text string

transport string

id string

Идентификатор

bums\crm\api\v03\Entity\SendingLog

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SendingLog
sendingTemplate SendingTemplate

status string

Возможные варианты: in_progress, failed, sent, recieved, paused

statusMessage string

title string

text string

transport string

timeCreated DateTime

id string

Идентификатор

bums\crm\api\v03\Entity\SendingTemplate

Описание

Рассылка

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SendingTemplate
sendings Коллекция

Возможные типы: Sending

sendingsCount integer

userCreated Employee

name string

title string

persons Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

personsCount integer

text string

transport string

isDropped boolean

timeCreated DateTime

isAuto boolean

status string

Возможные варианты: manually, planned, paused, in_progress, sent, failed

sendingWay string

Возможные варианты: all, first, prefer

id string

Идентификатор

bums\discuss\api\v03\Controller\Requests\ChangeParticipantsRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChangeParticipantsRequest
action* string

Возможные варианты: add, remove

participants* Коллекция

Возможные типы:

Employee

ContractorHuman

Group

bums\discuss\api\v03\Entity\Message

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Message
messageId string

Идентификатор сообщения

timeSent DateTime

Время отправки

from MessageContact

От кого

to Коллекция

Возможные типы: MessageContact

Адресат

copy Коллекция

Возможные типы: MessageContact

Копии сообщений

blindCopy Коллекция

Возможные типы: MessageContact

Скрытые копии сообщений

subject string

Сущность

text string

Текст сообщения

timeCreated DateTime

Время создания

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

isOutgoing boolean

Исходящее

isOutgoingForUser boolean

Исходящее ли сообщение дял текущего пользователя

deliveryStatus string

Возможные варианты: initial, sent, not_sent, delivered, not_delivered, read

Статус доставки

convertedTo Объединение
Возможные типы:
Comment

Task

Project

ContractorHuman

ContractorCompany

Deal

Topic

Конвертируется в сущность

isUnread boolean

unreadDeepChildsCount integer

interactionsCounters Коллекция

Возможные типы: InteractionCounter

rights MessageRights

parent Объединение
Возможные типы:
Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childs Коллекция

Возможные типы:

Message

FacebookMessage

WhatsappMessage

TelegramMessage

InstagramMessage

childsCount integer

deepChildsCount integer

lastErrorMessage string

id string

Идентификатор

bums\discuss\api\v03\Entity\MessageContact

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MessageContact
email* string

()

name string

bums\discuss\api\v03\Entity\MessageRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MessageRights
convertToTask boolean

bums\discuss\api\v03\Entity\MessagingEntityChecker

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MessagingEntityChecker
commentTransport Объединение
Возможные типы:
EmailTransportConfig

FacebookTransport

TelegramTransportConfig

InstagramTransportConfig

WhatsappTransportConfig

entity Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Deal

bums\discuss\api\v03\Entity\Poll

Описание

Голосование

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Poll
id string

Идентификатор

bums\discuss\api\v03\Entity\RawMessage

Описание

Необработанное сообщение

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RawMessage
type string

Возможные варианты: RAW_EMAIL

Тип сообщения (RAW_EMAIL, ZAIPER_TELEGRAM и т.д.)

message string

id string

Идентификатор

bums\discuss\api\v03\Entity\SearchContactResult

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SearchContactResult
isIntegration boolean

subject Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

bums\discuss\api\v03\Entity\Topic

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Topic
name string

content string

owner Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

visavis Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

participants* Коллекция

Возможные типы:

Employee

ContractorHuman

Group

participantsCount integer

lastComment Comment

avatars Коллекция

Возможные типы: string

isPrivate boolean

attaches Коллекция

Возможные типы: File

attachesCount integer

timeCreated DateTime

soundDisable boolean

isDiscussable boolean

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_edit, act_read, act_delete, act_edit_participants, act_comment

Список возможных действий

attachedTill DateTime

isAttachedForever boolean

linksCount integer

relationLinks Коллекция

Возможные типы: RelationLink

Связанные ссылки

relationLinksCount integer

Количество связанных ссылок

isHidden boolean

avatar File

Поле для загрузки аватара для обсуждения

isAttached boolean

Закреплено ли обсуждение для пользователя

folders Коллекция

Возможные типы: TopicFolder

foldersCount integer

interactionsCounters Коллекция

Возможные типы: InteractionCounter

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

conferenceParticipantsCount integer

Количество участников видеозвонка

conferenceSettings ConferenceSettings

allFiles Коллекция

Возможные типы:

File

FileGroup

Массив файлов

allFilesCount integer

Количество файлов

attachesInfo AttachesInfo

Информация о вложении

bums\discuss\api\v03\Entity\TopicFolder

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TopicFolder
name string

Название папки

topics Коллекция

Возможные типы: Topic

Первые 10 обсуждений из папки

topicsCount integer

Количество обсуждений в папке

id string

Идентификатор

bums\doc\api\v03\Entity\Doc

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Doc
name string

Название

generatedName string

Название с переменными

description string

Описание

actualVersion DocVersion

Версия документа

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_read, act_edit

Возможные действия

versions Коллекция

Возможные типы: DocVersion

versionsCount integer

folder DocFolder

docRights Коллекция

Возможные типы: DocRights

docRightsCount integer

isTemplate boolean

isDiscussable boolean

inheritRights boolean

templateObject string

Возможные варианты: task, project, contractor, invoice, deal

timeCreated DateTime

userCreated Employee

timeUpdated DateTime

userUpdated Employee

commentsWithoutTransportCount integer

interactionsCounters Коллекция

Возможные типы: InteractionCounter

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

tags Коллекция

Возможные типы: Tag

Метки

tagsCount integer

Количество меток

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

bums\doc\api\v03\Entity\DocFolder

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DocFolder
name* string

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_read

parent DocFolder

childs Коллекция

Возможные типы: DocFolder

childsCount integer

docs Коллекция

Возможные типы: Doc

docsCount integer

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

bums\doc\api\v03\Entity\DocRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DocRights
subject Объединение
Возможные типы:
Doc

DocFolder

user Объединение
Возможные типы:
Employee

Group

rights string

Возможные варианты: owner, editor, reader

id string

Идентификатор

bums\doc\api\v03\Entity\DocVersion

Описание

Версия документа

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DocVersion
name* string

Название

description string

Описание

comment string

Комментарий

mimeType string

number string

content Объединение
Возможные типы:
File

string

Файл

doc Doc

Документ

revision integer

Номер версии

timeCreated DateTime

Время создания

userCreated Employee

Создатель

timeUpdated DateTime

userUpdated Employee

editAbility string

Возможные варианты: allowed, forbidden_by_file, forbidden_by_product, forbidden_by_rights

Возможность редактирования

thumbnail File

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

bums\doc\api\v03\Entity\EditorConfig

Описание

Документ

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EditorConfig
url string

value string

session EditorSession

entity BaseEntity

parentEntity BaseEntity

parentField string

bums\doc\api\v03\Entity\EditorSession

Описание

Версия документа

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EditorSession
uniqId string

Уникальный идентификатор

status string

Возможные варианты: viewing, editing, saving, saved, cancelled

Статус

source BaseEntity

Источник

newModel BaseEntity

Сохраненная новая модель

id string

Идентификатор

bums\fin\api\v03\Controller\Request\CreateFinTransferRequest

Описание

Запрос на перевод средств

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateFinTransferRequest
sum Money

Сумма

date DateTime

Дата

creditAccount FinRealAccount

Счет получателя

debitAccount FinRealAccount

Счет отправителя

operationType FinOperationType

Тип финансовой операции

description string

Описание

id string

Идентификатор

bums\fin\api\v03\Entity\FinAccount

Описание

Счет из плана счетов

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FinAccount
name string

Название расчётного счёта

number string

Номер счета

id string

Идентификатор

bums\fin\api\v03\Entity\FinOperation

Описание

Финансовая операция

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FinOperation
number string

Номер этой операции

invoices Коллекция

Возможные типы: Invoice

Сделки

invoicesCount integer

Количество сделок

kind string

Возможные варианты: income, expense, virtual, transfer

Вид

status string

Возможные варианты: opened, closed

Статус

description string

Описание

date DateTime

Дата

timeUpdated DateTime

Дата обновления

creator Employee

Создатель

contractor Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Клиент

incomeSum Money

Сумма дохода

expenseSum Money

Сумма расхода

sum Money

Сумма

realAccount FinRealAccount

Расчётный счёт операции.

type FinOperationType

Тип операции.

controlDate DateTime

Контрольная дата

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_read

Возможные действия

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

pairedOperation FinOperation

Парные операции

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

bums\fin\api\v03\Entity\FinOperationImport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FinOperationImport
status string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

previousStatus string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

approveStatusText string

error string

file File

Файл для парсинга

columns Коллекция

Возможные типы: ImportColumn

columnsCount integer

rows Коллекция

Возможные типы: ImportRow

rowsCount integer

includeAllRows boolean

Включает/выключает все строки

validRowsCount integer

Количество отвалидированных (включенных) строк, которые будут сохранены

maxColumnsCountInRows integer

Максимальное количество колонок в строках текущей сессии

includedRows Коллекция

Возможные типы: ImportRow

includedRowsCount integer

invalidatedRows Коллекция

Возможные типы: ImportRow

Строки, которые не будут загружены из-за ошибок

invalidatedRowsCount integer

errorRows Коллекция

Возможные типы: ImportRow

Строки в которых есть критичные и не критичные ошибки, часть из них может быть загружена

errorRowsCount integer

supressNotifications boolean

savedRowsCount integer

Количество сохраненных строк

loadingProgress integer

Прогресс обработки строк в процентах

id string

Идентификатор

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FinOperationLink
primaryOperation FinOperation

secondaryOperation FinOperation

sum Money

id string

Идентификатор

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FinOperationTradeLink
buyOperation FinOperation

sellOperation FinOperation

sum Money

comment string

id string

Идентификатор

bums\fin\api\v03\Entity\FinOperationType

Описание

Тип финансовой операции

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FinOperationType
name string

Название

id string

Идентификатор

bums\fin\api\v03\Entity\FinRealAccount

Описание

Расчётный счёт

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FinRealAccount
name string

Название расчётного счёта

account FinAccount

Счет из плана счетов

currency Currency

Валюта

id string

Идентификатор

bums\integration\Api\v03\Entity\B24EntityTypeRight

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен B24EntityTypeRight
name string

entityType string

Возможные варианты: USER, COMPANY, DEAL, TASK, ACTIVITY, CALENDAR_EVENT

available boolean

enabled boolean

bums\integration\Api\v03\Entity\B24HookRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен B24HookRights
isValid boolean

entityTypeRights Коллекция

Возможные типы: B24EntityTypeRight

id string

Идентификатор

bums\integration\Api\v03\Entity\B24ImportProcess

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен B24ImportProcess
webHook string

stage string

Возможные варианты: webhook, config, processing, done, error, canceling, archive

entitySet Коллекция

Возможные типы: string

stepIndex integer

lastEntityType string

lastEntityId string

lastError string

timeCreated DateTime

timeUpdated DateTime

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

userUpdated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

id string

Идентификатор

bums\integration\Api\v03\Entity\B24ImportStep

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен B24ImportStep
name string

importProcess B24ImportProcess

bitrixType string

Возможные варианты: DEPARTMENT, USER, COMPANY, ADDRESS, CONTACT, PROGRAM, PROGRAM_STATUS, DEAL, TASK, ACTIVITY_TYPE, ACTIVITY, CALENDAR_EVENT

status string

Возможные варианты: started, done, error, waiting, skipped

successCount integer

errorCount integer

id string

Идентификатор

bums\integration\Api\v03\Entity\BaseIntegrationEntity

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BaseIntegrationEntity
uuid string

id string

Идентификатор

bums\integration\Api\v03\Entity\CustomLeadForm

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomLeadForm
name string

type string

Возможные варианты: deal, contractor

clientType string

Возможные варианты: human, company, WITHOUT_CONTRACTOR

Форма собственности клиента (человек\компания)

contractorInternalType* ContractorType

afterSubmitText string

collectUtm boolean

active boolean

elements Коллекция

Возможные типы: CustomLeadFormElement

elementsCount integer

program Program

programState ProgramState

needNotify boolean

tags Коллекция

Возможные типы: Tag

tagsCount integer

postCount integer

uuid string

timeCreated DateTime

userCreated Employee

responsible Employee

theme FormTheme

isCaptchaEnabled boolean

id string

Идентификатор

bums\integration\Api\v03\Entity\CustomLeadFormElement

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomLeadFormElement
name string

caption string

placeholder string

required boolean

sort integer

type string

Возможные варианты: text, phone, email, button, dropdown, checkbox, input, float, date, datetime, money

leadForm CustomLeadForm

isLogicField boolean

logicFieldType string

logicFieldSettings Коллекция

Возможные типы: LogicFieldParam

logicFieldSettingsCount integer

fieldSettings Коллекция

Возможные типы: FormElementParamValue

fieldSettingsCount integer

id string

Идентификатор

bums\integration\Api\v03\Entity\FormElementParam

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FormElementParam
name string

Имя параметра для отображения

description string

Описание параметра

values Коллекция

Возможные типы: any

Набор допустимых значений (для enum)

valueNames Коллекция

Возможные типы: any

Набор допустимых значений (для enum)

defaultValue any

Значение параметра по умолчанию

code string

Уникальный код параметра

type string

Возможные варианты: NUMBER, TEXT, DROPDOWN

Тип параметра (число, текст, дропдаун и тд)

supportedElementTypes Коллекция

Возможные типы: any

Возможные варианты: text, phone, email, button, dropdown, checkbox, input, float, date, datetime, money

Для каких элементов формы применим параметр

bums\integration\Api\v03\Entity\FormElementParamValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FormElementParamValue
name string

value string

bums\integration\Api\v03\Entity\FormFieldLogic

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FormFieldLogic
name string

Имя автоматизации для поля формы

description string

Описание автоматизации

params Коллекция

Возможные типы: any

Набор поддерживаемых параметров автоматизации

supportElementTypes Коллекция

Возможные типы: any

Типы элементов формы, на которые можно применить этот тип автоматизации

code string

Уникальный код автоматизации

bums\integration\Api\v03\Entity\FormTheme

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FormTheme
textColor* string

Цвет текста

inputColor* string

Цвет поля ввода

primaryColor* string

Основной цвет

secondaryColor* string

Дополнительный цвет

backgroundColor* string

Цвет фона

fullWidth* boolean

Во всю ширину

containerWidth integer

Ширина контейнера в px

align* string

Возможные варианты: left, center, right

Выравнивание элементов

borderRadius* integer

Скругление

marginLeft* integer

Отступ слева

marginRight* integer

Отступ справа

fieldSpacing* integer

Интервал между полями

bums\integration\Api\v03\Entity\Integration

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Integration
identifier string

Глобальный идентификатор

version integer

Номер версии

name* string

Название

description string

Описание

shortDescription string

Краткое описание

widgets Коллекция

Возможные типы: IntegrationWidget

Виджеты

widgetsCount integer

subscribedStreams Коллекция

Возможные типы: string

Возможные варианты: contractors, payers, deals, events, tasks, projects, employees, invoices, operations

Список потоков на которые подписана интеграция

streamUri string

Uri для отправки хуков

preferencesUri string

Uri страницы настроек приложения

pageUri string

Uri пользовательской страницы приложения

isEnabled boolean

scope Коллекция

Возможные типы: string

Пока не маппится, нужно только для установки, чтобы определить, что это телефония!

menuCustomItem MenuItem

Пункт меню, который создается приложением.

isWidget boolean

ownerAccountId integer

Id аккаунта создвшего приложение

owner Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Пользователь создавший приложение

marketStatus string

Возможные варианты: empty, sent, new_version, beta, released, rejected, disabled, not_market

Статус приложения

icon File

Иконка приложения

isFromMarket boolean

Флаг определяет установлено ли приложение из маркета

marketVersion integer

Опубликованная версия

email string

Email тех.поддержки приложения

testingData string

Информация для тестирования приложения

apiToken string

Токен для API

category string

Возможные варианты: telephony, tasks, crm, other

Категория приложения

type string

Возможные варианты: box, saas, all

Тип приложения

uuid string

id string

Идентификатор

bums\integration\Api\v03\Entity\IntegrationWidget

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IntegrationWidget
placeholder* string

Возможные варианты: common_informer, common_comment_body, common_comment_form, common_phone_number, common_telephony_widget, common_telephony_widget_config, common_telephony_widget_header, settings_api_telephony, employee_list, employee_add, employee_card_block, employee_card_info, employee_card_description, events_list, task_list, task_add, task_card_top, task_card_block, task_card_status, client_list, client_add, client_card_top, client_card_tabs, client_card_block, deal_list, deal_list_buttons, deal_add, deal_card_block, deal_card_status, deal_card_tabs, deal_card_top, deal_positions, doc_card_top

Название

content* string

Код виджета

appId integer

id приложения

application Integration

Приложение, с кот. связан виджет

appName string

Название приложения

name string

Название виджета

availableFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому доступен данный виджет

availableForCount integer

restrictedFor Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Кому ограничен доступ к виджету

restrictedForCount integer

isEnabled boolean

Доступен для текущего пользователя

uuid string

id string

Идентификатор

bums\integration\Api\v03\Entity\LogicFieldParam

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LogicFieldParam
name string

value string

bums\invoice\api\v03\Controller\Requests\OfferRowSortRequest

Описание

Запрос сортировки позиций сделки

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferRowSortRequest
current OfferRow

Текущая позиция счета

after OfferRow

Следующая позиция счета

bums\invoice\api\v03\Entity\Consignment

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Consignment
number string

timeCreated DateTime

Дата создания

timeUpdated DateTime

Дата обновления

userCreated Employee

Создатель

userUpdated Employee

Изменил

manager Employee

type string

Возможные варианты: income, expense

state string

Возможные варианты: created, reserved, performed, cancelled

plannedTime DateTime

Планируемая дата поступления/списания

actualTime DateTime

Дата проведения накладной

description string

attaches Коллекция

Возможные типы: File

attachesCount integer

contractor Объединение
Возможные типы:
ContractorCompany

ContractorHuman

rights ConsignmentRights

currency Currency

Валюта

price Money

Цена

taxSum Money

Сумма НДС

sumWithoutTax Money

Сумма без НДС

deal Deal

Сделка

interactionsCounters Коллекция

Возможные типы: InteractionCounter

rows Коллекция

Возможные типы: ConsignmentRow

rowsCount integer

isFixed boolean

isTemplate boolean

warehouse Warehouse

linkedConsignment Consignment

possibleStates Коллекция

Возможные типы: string

Возможные варианты: created, reserved, performed, cancelled

possibleWarehouses Коллекция

Возможные типы: Warehouse

possibleWarehousesCount integer

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

bums\invoice\api\v03\Entity\ConsignmentRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ConsignmentRights
editRows boolean

read boolean

edit boolean

cancel boolean

reserve boolean

perform boolean

create boolean

id string

Идентификатор

bums\invoice\api\v03\Entity\ConsignmentRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ConsignmentRow
consignment Consignment

offer Offer

unitName string

name string

quantity number

price Money

tax Tax

discount Discount

Скидка

margin Discount

Наценка

taxSum Money

Сумма НДС

sum Money

Стоимость

priceWithoutTax Money

Цена без НДС

offerCategoryName string

Название категории товара

id string

Идентификатор

bums\invoice\api\v03\Entity\DeficitOffer

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DeficitOffer
offer Offer

need number

available number

bums\invoice\api\v03\Entity\InvoiceDesktopWidget

Описание

Виджет "Счета"

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InvoiceDesktopWidget
statusFilterId string

periodFilterId string

sum Money

posX* integer

posY* integer

title string

Заголовок/название виджета

scale string

Возможные варианты: compact, iconic, spacious, free

Масштаб: компактный, портретный, просторный, свободный

id string

Идентификатор

bums\invoice\api\v03\Entity\InvoiceStatus

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InvoiceStatus
name string

Имя статуса

masterType string

Возможные варианты: created, drawn, paid, rejected

id string

Идентификатор

bums\invoice\api\v03\Entity\InvoiceTemplate

Описание

Шаблон инвойса

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InvoiceTemplate
name string

description string

numerationMask string

signatures any

stamp Коллекция

Возможные типы: File

stampCount integer

logo Коллекция

Возможные типы: File

logoCount integer

currency Currency

conditions string

language Language

timeCreated DateTime

timeUpdated DateTime

userCreated Employee

userUpdated Employee

isDefault boolean

isCustom boolean

customTemplate Doc

id string

Идентификатор

bums\invoice\api\v03\Entity\OfferCategory

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferCategory
name* string

Название

type string

Возможные варианты: product, service

parent OfferCategory

parents Коллекция

Возможные типы: OfferCategory

parentsCount integer

id string

Идентификатор

bums\invoice\api\v03\Entity\OfferImport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferImport
filter OfferFilter

Созданный в итоге фильтр по товарам

isPriceWithoutTax boolean

Устанавливать цену без учета НДС

warehouse Warehouse

Склад

updatedRowsCount integer

Количество обновленных сущностей

status string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

previousStatus string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

approveStatusText string

error string

file File

Файл для парсинга

columns Коллекция

Возможные типы: ImportColumn

columnsCount integer

rows Коллекция

Возможные типы: ImportRow

rowsCount integer

includeAllRows boolean

Включает/выключает все строки

validRowsCount integer

Количество отвалидированных (включенных) строк, которые будут сохранены

maxColumnsCountInRows integer

Максимальное количество колонок в строках текущей сессии

includedRows Коллекция

Возможные типы: ImportRow

includedRowsCount integer

invalidatedRows Коллекция

Возможные типы: ImportRow

Строки, которые не будут загружены из-за ошибок

invalidatedRowsCount integer

errorRows Коллекция

Возможные типы: ImportRow

Строки в которых есть критичные и не критичные ошибки, часть из них может быть загружена

errorRowsCount integer

supressNotifications boolean

savedRowsCount integer

Количество сохраненных строк

loadingProgress integer

Прогресс обработки строк в процентах

id string

Идентификатор

bums\invoice\api\v03\Entity\OfferPart

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferPart
offer Offer

Оригинальный товар

parent Offer

Родитель

count* number

Количество

isDropped boolean

Удален

id string

Идентификатор

bums\invoice\api\v03\Entity\OfferRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferRights
askWhenDelete boolean

Запросить подтверждение, если есть накладные в статусе Создана и Зарезервирована

produce boolean

Право на производство продукции

id string

Идентификатор

bums\invoice\api\v03\Entity\Warehouse

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Warehouse
name* string

Название

description string

Описание

attaches Коллекция

Возможные типы: File

Список вложений

attachesCount integer

Количество вложений

timeCreated DateTime

userCreated Employee

timeUpdated DateTime

userUpdated Employee

isDropped boolean

Удален ли склад

interactionsCounters Коллекция

Возможные типы: InteractionCounter

rights WarehouseRights

commentsWithoutTransportCount integer

Количество комментариев без транспорта

type WarehouseType

Класс

isActive boolean

linksCount integer

Количество связанных ссылок

id string

Идентификатор

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

isFavorite boolean

Избранная сущность или нет

allFiles Коллекция

Возможные типы:

File

FileGroup

Массив файлов

allFilesCount integer

Количество файлов

attachesInfo AttachesInfo

Информация о вложении

bums\invoice\api\v03\Entity\WarehouseBalance

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WarehouseBalance
warehouse Warehouse

offer Offer

balance number

available number

availableNow number

expected number

reserved number

id string

Идентификатор

bums\invoice\api\v03\Entity\WarehousePermission

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WarehousePermission
warehouse Warehouse

user Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

warehouseRights string

Возможные варианты: read, edit, full_access

incomeRights Коллекция

Возможные типы: string

Возможные варианты: read, create, reserve, perform, cancel

expenseRights Коллекция

Возможные типы: string

Возможные варианты: read, create, reserve, perform, cancel

id string

Идентификатор

bums\invoice\api\v03\Entity\WarehouseRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WarehouseRights
read boolean

edit boolean

remove boolean

editPermissions boolean

incomeConsignmentsRights ConsignmentRights

expenseConsignmentsRights ConsignmentRights

ultimateAccess boolean

id string

Идентификатор

bums\invoice\api\v03\Entity\WarehouseType

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WarehouseType
name string

Название

timeCreated DateTime

Дата создания

userCreated Employee

Создатель

timeUpdated DateTime

Дата обновления

userUpdated Employee

Редактор

id string

Идентификатор

bums\report\api\v03\Entity\CellContent\ComplexCellContent

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ComplexCellContent
type string

values Коллекция

Возможные типы:

DurationCellContent

EmptyCellContent

SumUpCellContent

TextCellContent

valuesCount integer

id string

Идентификатор

bums\report\api\v03\Entity\CellContent\DurationCellContent

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DurationCellContent
type string

value number

workingHours boolean

rowNumber integer

id string

Идентификатор

bums\report\api\v03\Entity\CellContent\EmptyCellContent

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmptyCellContent
type string

rowNumber integer

id string

Идентификатор

bums\report\api\v03\Entity\CellContent\LinkCellContent

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LinkCellContent
href string

type string

text string

rowNumber integer

id string

Идентификатор

bums\report\api\v03\Entity\CellContent\SumUpCellContent

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SumUpCellContent
type string

sum number

min number

avg number

max number

isInteger boolean

isDuration boolean

workingHours boolean

rowNumber integer

id string

Идентификатор

bums\report\api\v03\Entity\CellContent\TextCellContent

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TextCellContent
text string

type string

rowNumber integer

id string

Идентификатор

bums\report\api\v03\Entity\Config\ReportConfig

Описание

Конфиг настроек для отчета

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportConfig
columns Коллекция

Возможные типы: ReportConfigColumn

grouping Коллекция

Возможные типы: ReportConfigGrouping

filterRules string

readers Коллекция

Возможные типы:

Employee

Group

editors Коллекция

Возможные типы:

Employee

Group

entityType string

contextEntity BaseEntity

sortColumn string

bums\report\api\v03\Entity\Config\ReportConfigColumn

Описание

Конфиг колонки

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportConfigColumn
name string

alias string

currency string

formula string

bums\report\api\v03\Entity\Config\ReportConfigGrouping

Описание

Конфиг группировки

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportConfigGrouping
name string

additionalAgg boolean

collapsed boolean

sumUp boolean

extraSettings Коллекция

Возможные типы: ReportObjectGroupingExtraSetting

bums\report\api\v03\Entity\DataColumn\FirstColumn

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FirstColumn
type string

name string

Название

title string

Заголовок

align string

Выравнивание в колонке

nowrap boolean

Запрет переноса на новую строчку

currency string

formula string

id string

Идентификатор

bums\report\api\v03\Entity\DataColumn\ReportColumn

Описание

Sample:{ name: 'responsible', title: 'Ответственный' }

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportColumn
type string

name string

Название

title string

Заголовок

align string

Выравнивание в колонке

nowrap boolean

Запрет переноса на новую строчку

currency string

formula string

id string

Идентификатор

bums\report\api\v03\Entity\Desktop\ReportDesktopWidget

Описание

Виджет графика отчета на рабочем столе

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportDesktopWidget
reportId* string

chartType string

Возможные варианты: pie, bar

Тип графика

scale string

posX* integer

posY* integer

title string

Заголовок/название виджета

id string

Идентификатор

bums\report\api\v03\Entity\DisplaySetting\ChartSetting

Описание

Настройки одного графика

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChartSetting
componentName string

index integer

Порядковый номер для отображения графика

visible boolean

Видимость графика при отображении пользователю

key string

Ключ, который получается из данных таблицы из имени группируемого поля

id string

Идентификатор

bums\report\api\v03\Entity\DisplaySetting\ReportDisplaySetting

Описание

Настройки для отображения графиков

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportDisplaySetting
settings Коллекция

Возможные типы: ChartSetting

settingsCount integer

id string

Идентификатор

bums\report\api\v03\Entity\FunnelData

Описание

Данные для воронки продаж

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FunnelData
rows Коллекция

Возможные типы: DataRow

rowsCount integer

positive integer

negative integer

total integer

active integer

currency string

preset PresetInfo

totalPrice number

cacheKey string

id string

Идентификатор

bums\report\api\v03\Entity\Funnel\DataRow

Описание

Строка данных для воронки

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DataRow
count integer

progress integer

lose integer

left integer

Осталось

title string

result string

duration integer

summ number

isGroup boolean

statuses Коллекция

Возможные типы: StatusInfo

statusesCount integer

stateId integer

color string

id string

Идентификатор

bums\report\api\v03\Entity\Funnel\DealInfo

Описание

Данные о сделке в подробной таблице воронки продаж

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealInfo
price number

name string

link string

status string

manager string

managerLink string

duration integer

id string

Идентификатор

bums\report\api\v03\Entity\Funnel\PresetInfo

Описание

Данные для предустановленных графиков воронки

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PresetInfo
benefit number

Получено прибыли

missing number

Упущенная прибыль

success number

Закрыто успешно

failed number

Закрыто неуспешно

newbie number

Новых за указанный период

id string

Идентификатор

bums\report\api\v03\Entity\Funnel\StatusInfo

Описание

Информация о статусе

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен StatusInfo
name string

count integer

id string

Идентификатор

bums\report\api\v03\Entity\Report

Описание

Шаблон отчета

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Report
name* string

description string

displaySetting ReportDisplaySetting

config ReportConfig

readers Коллекция

Возможные типы:

Employee

Group

readersCount integer

editors Коллекция

Возможные типы:

Employee

Group

editorsCount integer

desktopWidget ReportDesktopWidget

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_read

userSortBy SortField

Пользовательская сортировка

timeCreated DateTime

userCreated Employee

timeUpdated DateTime

userUpdated Employee

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

bums\report\api\v03\Entity\ReportChartData

Описание

Новая версия ReportData

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportChartData
groups Коллекция

Возможные типы: ReportGroup

groupsCount integer

objectType string

id string

Идентификатор

bums\report\api\v03\Entity\ReportData

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportData
columns Коллекция

Возможные типы: ReportColumn

columnsCount integer

rows Коллекция

Возможные типы: ReportRow

rowsCount integer

total TotalReportRow

nextOffset integer

id string

Идентификатор

bums\report\api\v03\Entity\ReportGroup

Описание

Сущность с данными группировки по отчету

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportGroup
subGroups Коллекция

Возможные типы: ReportGroup

subGroupsCount integer

name string

count integer

column string

id string

Идентификатор

bums\report\api\v03\Entity\ReportObject\ReportObject

Описание

Информация об объекте, по которому можно построить отчет

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportObject
columns Коллекция

Возможные типы: ReportObjectColumn

columnsCount integer

grouping Коллекция

Возможные типы: ReportObjectGrouping

groupingCount integer

title string

id string

Идентификатор

bums\report\api\v03\Entity\ReportObject\ReportObjectColumn

Описание

Описание колонки конструктора отчета

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportObjectColumn
name string

title string

isMoney boolean

isComplex boolean

isFormula boolean

formula string

type string

canSelectCurrency boolean

bums\report\api\v03\Entity\ReportObject\ReportObjectGrouping

Описание

Описание группировки конструктора отчета

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportObjectGrouping
name string

title string

extraSettings Коллекция

Возможные типы: ReportObjectGroupingExtraSetting

bums\report\api\v03\Entity\ReportObject\ReportObjectGroupingExtraSetting

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportObjectGroupingExtraSetting
name string

choices Коллекция

Возможные типы: string

selectedChoice string

bums\report\api\v03\Entity\Row\GroupRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GroupRow
type string

collapsed boolean

subRows Коллекция

Возможные типы: ReportRow

subRowsCount integer

name string

Имя группировки

value string

Значение группировки

count integer

Количество элементов в группировке

id string

Id группы

parentId string

Id родительской группы. Нужно для правильного мержа при подгрузке порциями

dataOffset integer

Смещение для данных отчёта этой группы в общем списке данных отчета

cells Коллекция

Возможные типы:

DurationCellContent

EmptyCellContent

SumUpCellContent

TextCellContent

Ячейки строки в виде хеша ключ-значение, где ключ - имя колонки.Значение может быть массивом - это многострочное значение

cellsCount integer

bums\report\api\v03\Entity\Row\ReportRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ReportRow
type string

cells Коллекция

Возможные типы:

DurationCellContent

EmptyCellContent

SumUpCellContent

TextCellContent

Ячейки строки в виде хеша ключ-значение, где ключ - имя колонки.Значение может быть массивом - это многострочное значение

cellsCount integer

id string

Идентификатор

bums\report\api\v03\Entity\Row\TotalReportRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TotalReportRow
type string

count integer

additionalMetrics integer

cells Коллекция

Возможные типы:

DurationCellContent

EmptyCellContent

SumUpCellContent

TextCellContent

Ячейки строки в виде хеша ключ-значение, где ключ - имя колонки.Значение может быть массивом - это многострочное значение

cellsCount integer

id string

Идентификатор

bums\settings\api\v03\Controller\Request\MobileOrderLead

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MobileOrderLead
phone string

email string

comment string

bums\settings\api\v03\Entity\Account

Описание

Состояние аккаунта

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Account
id string

currentTariff AccountTariff

Текущий тариф

promoUrl string

Ссылка на ЛК

licenseCount integer

Текущее число лицензий

monthCount integer

Количество месяцев при последнем продлении

tariffs Коллекция

Возможные типы: AccountTariff

Доступные для аккаунта тарифы

tariffsCount integer

smsCount integer

Смс-баланс

expirationDate DateOnly

Смс-баланс

registrationSource string

Источник регистрации

bums\settings\api\v03\Entity\AccountAutoPay

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AccountAutoPay
id string

state string

Статус

sum Money

Сумма

nextPayTime DateTime

Дата следующей оплаты

description string

Описание

bums\settings\api\v03\Entity\AccountDoc

Описание

Документ клиента

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AccountDoc
name* string

Название файла вместе с расширением

url* string

Путь к файлу для скачивания

timeCreated DateTime

size string

id string

Идентификатор

bums\settings\api\v03\Entity\AccountOrder

Описание

Заказ клиента (сделка в megaplan.megaplan.ru)

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AccountOrder
id string

Соответствует id сделки в mm.ru

productType string

Тип продукта

tariff AccountTariff

Тариф

licenseCount integer

Число лицензий

monthCount integer

Количество месяцев

price number

Цена заказа

currency Currency

Валюта

isUnpaid boolean

Оплаченность

isTelephony boolean

Является ли заказ услугой телефонии

isLastUnpaid boolean

Последняя неоплаченная сделка?

description string

Описание

status string

Статус

inProcess boolean

В обработке

date DateOnly

Дата

shortDescription string

Краткое описание

oldLicenseCount integer

Число лицензий на момент создания заказа

packetObject string

Тип объекта, пакет которых покупается

packetObjectCount integer

Количество объектов в пакете

bums\settings\api\v03\Entity\AccountOrderPrice

Описание

Итоговая цена заказа

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AccountOrderPrice
description string

price number

currency Currency

bums\settings\api\v03\Entity\AccountTariff

Описание

Тариф мегаплана

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AccountTariff
id string

Возможные варианты: collaboration2012, collaborationplus, crmlite, crm2012, crmplus, crm2020, crmbusiness

name string

price number

currency Currency

bums\settings\api\v03\Entity\EditionExceed

Описание

Превышение ограничения количества объектов

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EditionExceed
id string

message string

Сообщение об ошибке

active boolean

Активность

bums\settings\api\v03\Entity\InterviewResult

Описание

Ответы пользователя на onboarding опрос

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InterviewResult
email string

mobileGoals string

comment string

activityType string

isCustomActivityType boolean

nameOfYourCompany string

isCustomNameOfYourCompany boolean

id string

Идентификатор

bums\settings\api\v03\Entity\ObjectPacket

Описание

Пакет объектов

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ObjectPacket
id string

price Money

Цена

size integer

Размер

buyPossible boolean

Возможность покупки

bums\spaces\api\v03\Controller\Requests\ApplyTemplateRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ApplyTemplateRequest
templates Коллекция

Возможные типы: Template

bums\spaces\api\v03\Controller\Requests\ChangeFieldRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChangeFieldRequest
value Объединение
Возможные типы:
Number

DateTime

DateOnly

string

boolean

SpaceMoney

Ref

Select

User

SpaceFile

SpaceDateInterval

SpaceStatus

bums\spaces\api\v03\Controller\Requests\ChangeFieldTypeRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChangeFieldTypeRequest
type string

Возможные варианты: Number, string, User, Ref, RefList, Select, DateTime, boolean, SpaceFile, DateOnly, SpaceStatus, Relation

bums\spaces\api\v03\Controller\Requests\ChangeListFieldValueRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChangeListFieldValueRequest
value Коллекция

Возможные типы:

Ref

Select

User

SpaceFile

SpaceStatus

bums\spaces\api\v03\Controller\Requests\CreateRowRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateRowRequest
value Коллекция

Возможные типы: CreateRowField

id string

Идентификатор

bums\spaces\api\v03\Controller\Requests\DeleteRowsRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DeleteRowsRequest
rows Коллекция

Возможные типы: WidgetLayoutDataRow

bums\spaces\api\v03\Controller\Requests\GroupsConfigRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GroupsConfigRequest
groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

filter Коллекция

Возможные типы: WidgetFilter

aggregation WidgetAggregation

bums\spaces\api\v03\Controller\Requests\RowsConfigRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RowsConfigRequest
groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

filter Коллекция

Возможные типы: WidgetFilter

fields Коллекция

Возможные типы: DataSourceField

groupValue WidgetLayoutGroup

bums\spaces\api\v03\Entity\AccessSettingsItem

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AccessSettingsItem
element Element

Элемент на который изначально выданы права

member Объединение
Возможные типы:
Group

ContractorCompany

ContractorHuman

Employee

Anonymous

Пользователь или группа

accessLevel string

Возможные варианты: read, edit, share

Уровень доступа

canEdit boolean

Возможность редактирования

bums\spaces\api\v03\Entity\Action

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Action
title string

icon string

bums\spaces\api\v03\Entity\Aggregation\AggregationOperation

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AggregationOperation
alias string

name* string

Возможные варианты: sum, count, max, min, avg, filled, empty

possibleFieldTypes Коллекция

Возможные типы: string

bums\spaces\api\v03\Entity\Aggregation\AggregationResult

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AggregationResult
value Объединение
Возможные типы:
Number

SpaceMoney

DateTime

DateOnly

aggregation WidgetAggregation

bums\spaces\api\v03\Entity\Automation\Actions\AutomationCreateAction

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationCreateAction
widgetId string

fields Коллекция

Возможные типы: AutomationFieldUpdateRequest

id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\Actions\AutomationDuplicateAction

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationDuplicateAction
id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\Actions\AutomationUpdateAction

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationUpdateAction
dataSelection AutomationDataSelection

fields Коллекция

Возможные типы: AutomationFieldUpdateRequest

id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\Automation

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Automation
name string

description string

config AutomationConfig

group AutomationGroup

enabled boolean

id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\AutomationActionsGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationActionsGroup
filter Коллекция

Возможные типы: WidgetFilter

actions Коллекция

Возможные типы:

AutomationCreateAction

AutomationDuplicateAction

AutomationUpdateAction

actionsCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\AutomationConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationConfig
trigger Объединение
Возможные типы:
AutomationCreateTrigger

AutomationScheduleTrigger

AutomationUpdateTrigger

automationActionsGroups Коллекция

Возможные типы: AutomationActionsGroup

automationActionsGroupsCount integer

isDraft boolean

bums\spaces\api\v03\Entity\Automation\AutomationFieldUpdateRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationFieldUpdateRequest
fieldName string

value Объединение
Возможные типы:
Number

DateTime

DateOnly

string

boolean

Select

bums\spaces\api\v03\Entity\Automation\AutomationGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationGroup
name string

automations Коллекция

Возможные типы: Automation

automationsCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\DataSelections\AutomationDataSelection

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationDataSelection
widgetId string

filter Коллекция

Возможные типы: WidgetFilter

id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\Triggers\AutomationCreateTrigger

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationCreateTrigger
widgetId string

id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\Triggers\AutomationScheduleTrigger

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationScheduleTrigger
id string

Идентификатор

bums\spaces\api\v03\Entity\Automation\Triggers\AutomationUpdateTrigger

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AutomationUpdateTrigger
widgetId string

fieldsName Коллекция

Возможные типы: string

id string

Идентификатор

bums\spaces\api\v03\Entity\CustomDataSource\BaseFieldsSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BaseFieldsSettings
isDefault boolean

isReadOnly boolean

bums\spaces\api\v03\Entity\CustomDataSource\CustomDataSource

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomDataSource
name* string

dataSourceType string

fields Коллекция

Возможные типы: CustomDataSourceField

fieldsCount integer

mainField CustomDataSourceMainField

Главное поле, которые всегда первое, и его нельзя удалить.

id string

Идентификатор

bums\spaces\api\v03\Entity\CustomDataSource\CustomDataSourceField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomDataSourceField
name string

alias string

type string

Возможные варианты: Number, string, User, Ref, RefList, Select, DateTime, boolean, SpaceFile, DateOnly, SpaceStatus, Relation

availableValues Коллекция

Возможные типы: string

availableValuesCount integer

canEdit boolean

isDefault boolean

settings Объединение
Возможные типы:
BaseFieldsSettings

SelectFieldsSettings

StatusFieldsSettings

RelationFieldSettings

FileFieldsSettings

UserFieldSettings

settingsCount integer

isLocked boolean

id string

Идентификатор

bums\spaces\api\v03\Entity\CustomDataSource\CustomDataSourceMainField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomDataSourceMainField
name string

alias string

bums\spaces\api\v03\Entity\CustomDataSource\CustomDataSourceSystemField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CustomDataSourceSystemField
name* string

canEdit boolean

isDefault boolean

id string

Идентификатор

bums\spaces\api\v03\Entity\CustomDataSource\FileFieldsSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FileFieldsSettings
isDefault boolean

isReadOnly boolean

bums\spaces\api\v03\Entity\CustomDataSource\RelationFieldSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RelationFieldSettings
isDefault boolean

isReadOnly boolean

element Element

mode string

Возможные варианты: one, many

isBound boolean

boundFieldName string

canViewRelatedData boolean

relatedFields Коллекция

Возможные типы: DataSourceField

bums\spaces\api\v03\Entity\CustomDataSource\SelectFieldsSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SelectFieldsSettings
isDefault boolean

isMultiple boolean

isReadOnly boolean

availableValues Коллекция

Возможные типы: Select

bums\spaces\api\v03\Entity\CustomDataSource\StatusFieldsSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен StatusFieldsSettings
isDefault boolean

isReadOnly boolean

statuses Коллекция

Возможные типы: SpaceStatus

bums\spaces\api\v03\Entity\CustomDataSource\UserFieldSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UserFieldSettings
isDefault boolean

isMultiple boolean

isReadOnly boolean

bums\spaces\api\v03\Entity\DataSet

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DataSet
dataSource string

id string

Идентификатор

bums\spaces\api\v03\Entity\DataSource

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DataSource
name string

type string

Возможные варианты: integration, custom, link

subject Объединение
Возможные типы:
Element

SpaceIntegrationModule

CustomDataSource

id string

Идентификатор

bums\spaces\api\v03\Entity\DataSourceField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DataSourceField
name string

alias string

type string

Возможные варианты: Number, string, User, Ref, RefList, Select, DateTime, SpaceMoney, boolean, SpaceFile, DateOnly, SpaceDateInterval, SpaceStatus, Relation

elementType string

Возможные варианты: Ref, Select, User, SpaceFile, SpaceStatus

values Коллекция

Возможные типы: string

linkType string

isRequired boolean

isLocked boolean

isReadOnly boolean

bums\spaces\api\v03\Entity\Element

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Element
type* string

Возможные варианты: Space, Widget, WidgetView, ElementLink, Note, Iframe

title* string

icon string

accessLevel string

Возможные варианты: full, write, read

path Коллекция

Возможные типы: Element

pathCount integer

childrenCount integer

linkedElement Element

inFavorites boolean

lastVisited DateTime

inTrash boolean

defaultLayoutId string

isSystem boolean

defaultLayoutType string

Возможные варианты: Table, Board, Calendar, Timeline, BarChart, PieChart, LineChart, Chart

pending boolean

isCustom boolean

Кастомный датасорс или нет

id string

Идентификатор

bums\spaces\api\v03\Entity\ElementCloneRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ElementCloneRequest
copyData boolean

bums\spaces\api\v03\Entity\ElementIdResponse

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ElementIdResponse
id string

Идентификатор

bums\spaces\api\v03\Entity\ElementShareByLinkResponse

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ElementShareByLinkResponse
url string

uuid string

id string

Идентификатор

bums\spaces\api\v03\Entity\FieldConditions

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FieldConditions
comparisons Коллекция

Возможные типы: string

bums\spaces\api\v03\Entity\FieldSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FieldSettings
field DataSourceField

isExpandedView boolean

bums\spaces\api\v03\Entity\FieldType

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FieldType
type string

comparisons Коллекция

Возможные типы: string

defaultComparison string

bums\spaces\api\v03\Entity\Fields\CreateRowField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateRowField
fieldName string

value Объединение
Возможные типы:
ChangeFieldRequest

ChangeListFieldValueRequest

bums\spaces\api\v03\Entity\Fields\DateShift

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateShift
unit string

Возможные варианты: second, minute, hour, day, week, month, quarter, year

Единица измерения

delta* integer

Сдвиг

bums\spaces\api\v03\Entity\Fields\Number

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Number
value number

unit string

bums\spaces\api\v03\Entity\Fields\Ref

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Ref
color string

title string

id string

Идентификатор

bums\spaces\api\v03\Entity\Fields\RefList

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RefList
value Коллекция

Возможные типы:

Ref

Select

User

SpaceFile

SpaceStatus

count integer

bums\spaces\api\v03\Entity\Fields\Select

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Select
color string

title string

id string

Идентификатор

bums\spaces\api\v03\Entity\Fields\SpaceDateInterval

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceDateInterval
from Объединение
Возможные типы:
DateTime

DateOnly

to Объединение
Возможные типы:
DateTime

DateOnly

bums\spaces\api\v03\Entity\Fields\SpaceFile

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceFile
url string

extension string

title string

id string

Идентификатор

bums\spaces\api\v03\Entity\Fields\SpaceMoney

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceMoney
value number

currency Ref

bums\spaces\api\v03\Entity\Fields\SpaceStatus

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceStatus
color string

title string

id string

Идентификатор

bums\spaces\api\v03\Entity\Fields\User

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен User
avatar string

title string

id string

Идентификатор

bums\spaces\api\v03\Entity\GroupValue\MonthGroupValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MonthGroupValue
year integer

month integer

monthName string

bums\spaces\api\v03\Entity\GroupValue\QuarterGroupValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен QuarterGroupValue
year integer

month integer

day integer

duration integer

bums\spaces\api\v03\Entity\GroupValue\WeekGroupValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WeekGroupValue
year integer

month integer

day integer

bums\spaces\api\v03\Entity\GroupValue\YearGroupValue

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен YearGroupValue
year integer

bums\spaces\api\v03\Entity\Groups\DateWidgetGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateWidgetGroup
exceptGroups Коллекция

Возможные типы:

DateTime

QuarterGroupValue

MonthGroupValue

WeekGroupValue

YearGroupValue

DateOnly

WidgetGroupEmpty

period string

Возможные варианты: day, month, year, week, quarter

field* string

hideEmpty boolean

sort string

Возможные варианты: desc, asc, custom

bums\spaces\api\v03\Entity\Groups\WidgetGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetGroup
exceptGroups Коллекция

Возможные типы:

Ref

Select

User

WidgetGroupEmpty

SpaceStatus

field* string

hideEmpty boolean

sort string

Возможные варианты: desc, asc, custom

bums\spaces\api\v03\Entity\Groups\WidgetGroupEmpty

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetGroupEmpty
value string

bums\spaces\api\v03\Entity\Iframe\IframeFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IframeFullPreview
url string

bums\spaces\api\v03\Entity\Iframe\IframeSmallPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IframeSmallPreview
url string

bums\spaces\api\v03\Entity\Iframe\IframeUrl

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен IframeUrl
url string

id string

Идентификатор

bums\spaces\api\v03\Entity\Import\FileImport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FileImport
file File

status string

Возможные варианты: downloading, downloaded, creating, importing, imported, error

statusMessage string

widget Element

progress integer

lastImport DateTime

id string

Идентификатор

bums\spaces\api\v03\Entity\Import\SpaceImport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceImport
status string

Возможные варианты: downloading, downloaded, creating, importing, imported, error

statusMessage string

widget Element

progress integer

lastImport DateTime

id string

Идентификатор

bums\spaces\api\v03\Entity\Import\google\GoogleAuthData

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GoogleAuthData
code string

bums\spaces\api\v03\Entity\Import\google\GoogleImport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GoogleImport
status string

Возможные варианты: downloading, downloaded, creating, importing, imported, error, need_oauth2

documentUrl string

statusMessage string

widget Element

progress integer

lastImport DateTime

id string

Идентификатор

bums\spaces\api\v03\Entity\Import\google\GoogleInitParams

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GoogleInitParams
documentUrl string

widget Element

returnPath string

bums\spaces\api\v03\Entity\Import\google\GoogleInitResult

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GoogleInitResult
status string

statusMessage string

authUrl string

importProcess GoogleImport

bums\spaces\api\v03\Entity\Industry

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Industry
name* string

code* string

id string

Идентификатор

bums\spaces\api\v03\Entity\InfoGraphicsData

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InfoGraphicsData
dataSetMaximum Коллекция

Возможные типы: number

dataSetsUnits Коллекция

Возможные типы: string

rows Коллекция

Возможные типы: WidgetInfoGraphicsDataRow

dataSetsDisplayOnSecondaryAxis Коллекция

Возможные типы: boolean

bums\spaces\api\v03\Entity\Integration\SpaceIntegrationInstance

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceIntegrationInstance
name* string

type* string

url string

status string

statusMessage string

progress integer

lastSync DateTime

id string

Идентификатор

bums\spaces\api\v03\Entity\LayoutDataField

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LayoutDataField
name string

alias string

sort string

Возможные варианты: asc, desc

bums\spaces\api\v03\Entity\Note\NoteEdition

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NoteEdition
previewText* string

text* string

id string

Идентификатор

bums\spaces\api\v03\Entity\Note\NoteFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NoteFullPreview
previewText string

bums\spaces\api\v03\Entity\Note\NoteSmallPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NoteSmallPreview
previewText string

bums\spaces\api\v03\Entity\Preview\BarChartFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BarChartFullPreview
dataSetsDisplayOnSecondaryAxis Коллекция

Возможные типы: boolean

accumulation string

Возможные варианты: byValue, byPercent, empty

dataSetsName Коллекция

Возможные типы: string

rows Коллекция

Возможные типы: WidgetInfoGraphicsDataRow

rowsCount integer

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\BarChartPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BarChartPreview
values Коллекция

Возможные типы: ChartPreviewElement

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\BoardFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BoardFullPreview
totalAggregationResults Коллекция

Возможные типы: AggregationResult

previewGroups Коллекция

Возможные типы: PreviewGroup

bums\spaces\api\v03\Entity\Preview\BoardPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BoardPreview
values Коллекция

Возможные типы:

Number

SpaceMoney

DateTime

DateOnly

bums\spaces\api\v03\Entity\Preview\CalendarFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CalendarFullPreview
date DateOnly

rowsCount integer

previewRows Коллекция

Возможные типы: CalendarFullPreviewRow

bums\spaces\api\v03\Entity\Preview\CalendarFullPreviewRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CalendarFullPreviewRow
title string

interval SpaceDateInterval

bums\spaces\api\v03\Entity\Preview\CalendarPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CalendarPreview
todayCount integer

tomorrowCount integer

bums\spaces\api\v03\Entity\Preview\ChartFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChartFullPreview
dataSetsDisplayOnSecondaryAxis Коллекция

Возможные типы: boolean

dataSetsName Коллекция

Возможные типы: string

rows Коллекция

Возможные типы: WidgetInfoGraphicsDataRow

rowsCount integer

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\ChartPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChartPreview
values Коллекция

Возможные типы: ChartPreviewElement

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\ChartPreviewElement

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChartPreviewElement
values Коллекция

Возможные типы: Number

bums\spaces\api\v03\Entity\Preview\ElementLinkPreview

bums\spaces\api\v03\Entity\Preview\GroupedTableFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GroupedTableFullPreview
totalAggregationResults Коллекция

Возможные типы: AggregationResult

previewGroups Коллекция

Возможные типы: PreviewGroup

bums\spaces\api\v03\Entity\Preview\LineChartFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LineChartFullPreview
dataSetsDisplayOnSecondaryAxis Коллекция

Возможные типы: boolean

accumulation string

Возможные варианты: byValue, byPercent, empty

dataSetsName Коллекция

Возможные типы: string

rows Коллекция

Возможные типы: WidgetInfoGraphicsDataRow

rowsCount integer

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\LineChartPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LineChartPreview
values Коллекция

Возможные типы: ChartPreviewElement

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\PieChartFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PieChartFullPreview
aggregationResults Коллекция

Возможные типы: AggregationResult

dataSetsName Коллекция

Возможные типы: string

rows Коллекция

Возможные типы: WidgetInfoGraphicsDataRow

rowsCount integer

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\PieChartPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PieChartPreview
values Коллекция

Возможные типы: ChartPreviewElement

dataSetsMaximum Коллекция

Возможные типы: number

bums\spaces\api\v03\Entity\Preview\PreviewGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PreviewGroup
value Объединение
Возможные типы:
DateTime

Ref

SpaceStatus

User

WidgetGroupEmpty

QuarterGroupValue

WeekGroupValue

MonthGroupValue

YearGroupValue

DateOnly

Select

aggregationResults Коллекция

Возможные типы: AggregationResult

bums\spaces\api\v03\Entity\Preview\SpaceFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceFullPreview
values Коллекция

Возможные типы:

SpacePreview

TablePreview

BoardPreview

CalendarPreview

TimelinePreview

BarChartPreview

ChartPreview

LineChartPreview

PieChartPreview

NoteSmallPreview

IframeSmallPreview

elements Коллекция

Возможные типы: Element

bums\spaces\api\v03\Entity\Preview\SpacePreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpacePreview
values Коллекция

Возможные типы: string

bums\spaces\api\v03\Entity\Preview\TablePreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TablePreview
totalAggregationResults Коллекция

Возможные типы: AggregationResult

previewGroups Коллекция

Возможные типы: PreviewGroup

bums\spaces\api\v03\Entity\Preview\TablePreviewRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TablePreviewRow
title string

bums\spaces\api\v03\Entity\Preview\TimelineFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TimelineFullPreview
date DateOnly

rowsCount integer

previewRows Коллекция

Возможные типы: TimelineFullPreviewRow

bums\spaces\api\v03\Entity\Preview\TimelineFullPreviewRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TimelineFullPreviewRow
title string

interval SpaceDateInterval

bums\spaces\api\v03\Entity\Preview\TimelinePreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TimelinePreview
todayCount integer

tomorrowCount integer

bums\spaces\api\v03\Entity\Preview\UngroupedTableFullPreview

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UngroupedTableFullPreview
count integer

rows Коллекция

Возможные типы: TablePreviewRow

operation* string

Возможные варианты: sum, count, max, min, avg, filled, empty

totalAggregationResults Коллекция

Возможные типы: AggregationResult

bums\spaces\api\v03\Entity\Report\CreateReportConfigRequest

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateReportConfigRequest
reportKey string

bums\spaces\api\v03\Entity\Settings\BarChartSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BarChartSettings
accumulation string

Возможные варианты: byValue, byPercent, empty

compareTo Коллекция

Возможные типы: ChartCompareTo

aggregations Коллекция

Возможные типы: WidgetAggregation

groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

mainDataSourceName string

tableFields Коллекция

Возможные типы: DataSourceField

sortConfig InfographicsSortConfig

bums\spaces\api\v03\Entity\Settings\BoardSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BoardSettings
groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

swimLaneGroup Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

fields Коллекция

Возможные типы: DataSourceField

aggregations Коллекция

Возможные типы: WidgetAggregation

sortConfig WidgetSortConfig

mainField DataSourceField

isExpandedRowView boolean

fieldsSettings Коллекция

Возможные типы: FieldSettings

bums\spaces\api\v03\Entity\Settings\CalendarSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CalendarSettings
startDateField DataSourceField

endDateField DataSourceField

fields Коллекция

Возможные типы: DataSourceField

aggregations Коллекция

Возможные типы: WidgetAggregation

sortConfig WidgetSortConfig

mainField DataSourceField

isExpandedRowView boolean

fieldsSettings Коллекция

Возможные типы: FieldSettings

bums\spaces\api\v03\Entity\Settings\ChartCompareTo

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChartCompareTo
dataSource DataSource

title string

aggregation WidgetAggregation

groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

filter Коллекция

Возможные типы: WidgetFilter

displayOnSecondaryAxis boolean

tableFields Коллекция

Возможные типы: DataSourceField

id string

Идентификатор

bums\spaces\api\v03\Entity\Settings\ChartSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChartSettings
compareTo Коллекция

Возможные типы: ChartCompareTo

aggregations Коллекция

Возможные типы: WidgetAggregation

groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

mainDataSourceName string

tableFields Коллекция

Возможные типы: DataSourceField

sortConfig InfographicsSortConfig

bums\spaces\api\v03\Entity\Settings\InfographicsSortConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InfographicsSortConfig
sort Объединение
Возможные типы:
SortByNameConfig

SortByValueConfig

SortCustomConfig

bums\spaces\api\v03\Entity\Settings\LineChartSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен LineChartSettings
accumulation string

Возможные варианты: byValue, byPercent, empty

compareTo Коллекция

Возможные типы: ChartCompareTo

aggregations Коллекция

Возможные типы: WidgetAggregation

groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

mainDataSourceName string

tableFields Коллекция

Возможные типы: DataSourceField

sortConfig InfographicsSortConfig

bums\spaces\api\v03\Entity\Settings\PieChartSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PieChartSettings
aggregations Коллекция

Возможные типы: WidgetAggregation

groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

mainDataSourceName string

tableFields Коллекция

Возможные типы: DataSourceField

sortConfig InfographicsSortConfig

bums\spaces\api\v03\Entity\Settings\SortByNameConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SortByNameConfig
type string

direction string

Возможные варианты: asc, desc

bums\spaces\api\v03\Entity\Settings\SortByValueConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SortByValueConfig
type string

dataSetId string

direction string

Возможные варианты: asc, desc

bums\spaces\api\v03\Entity\Settings\SortCustomConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SortCustomConfig
type string

bums\spaces\api\v03\Entity\Settings\TableSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TableSettings
groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

fields Коллекция

Возможные типы: DataSourceField

aggregations Коллекция

Возможные типы: WidgetAggregation

sortConfig WidgetSortConfig

mainField DataSourceField

isExpandedRowView boolean

fieldsSettings Коллекция

Возможные типы: FieldSettings

bums\spaces\api\v03\Entity\Settings\TimelineSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TimelineSettings
groupBy Объединение
Возможные типы:
DateWidgetGroup

WidgetGroup

startDateField DataSourceField

endDateField DataSourceField

fields Коллекция

Возможные типы: DataSourceField

aggregations Коллекция

Возможные типы: WidgetAggregation

sortConfig WidgetSortConfig

mainField DataSourceField

isExpandedRowView boolean

fieldsSettings Коллекция

Возможные типы: FieldSettings

bums\spaces\api\v03\Entity\ShareByLinkSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ShareByLinkSettings
elementId string

Элемент на который изначально выдаются права

elementPath string

Путь для отображения элемента

accessLevel string

Возможные варианты: read, edit

Уровень доступа

bums\spaces\api\v03\Entity\SpaceIntegration

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceIntegration
name* string

url string

id string

Идентификатор

bums\spaces\api\v03\Entity\SpaceIntegrationModule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SpaceIntegrationModule
integration SpaceIntegration

name* string

url* string

bums\spaces\api\v03\Entity\StatisticItem

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен StatisticItem
elementTreeId* string

lastViews Коллекция

Возможные типы: StatisticUser

bums\spaces\api\v03\Entity\StatisticUser

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен StatisticUser
userId* integer

leftTime* integer

bums\spaces\api\v03\Entity\Template

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Template
name* string

code* string

id string

Идентификатор

bums\spaces\api\v03\Entity\UserGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UserGroup
id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetAggregation

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetAggregation
name string

field string

operation* string

Возможные варианты: sum, count, max, min, avg, filled, empty

bums\spaces\api\v03\Entity\WidgetBatchDataRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetBatchDataRow
rows Коллекция

Возможные типы: WidgetLayoutDataRow

rowsCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetCondition

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetCondition
comparison string

values Коллекция

Возможные типы:

WidgetCondition

Number

SpaceMoney

DateOnly

DateTime

boolean

Ref

Select

SpaceFile

SpaceStatus

User

string

DateShift

IntervalDates

IntervalTime

DataSourceField

valuesCount integer

field string

value Объединение
Возможные типы:
WidgetCondition

Number

SpaceMoney

DateOnly

DateTime

boolean

Ref

Select

SpaceFile

SpaceStatus

User

string

DateShift

IntervalDates

IntervalTime

DataSourceField

bums\spaces\api\v03\Entity\WidgetConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetConfig
layouts Коллекция

Возможные типы: WidgetLayout

layoutsCount integer

dataSet DataSet

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetFilter
condition WidgetCondition

bums\spaces\api\v03\Entity\WidgetInfoGraphicsDataRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetInfoGraphicsDataRow
group Объединение
Возможные типы:
DateTime

Ref

SpaceStatus

User

WidgetGroupEmpty

QuarterGroupValue

WeekGroupValue

MonthGroupValue

YearGroupValue

DateOnly

Select

values Коллекция

Возможные типы:

Number

SpaceMoney

valuesCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetLayout
type string

Возможные варианты: Table, Board, Calendar, Timeline, BarChart, PieChart, LineChart, Chart

name string

filter Коллекция

Возможные типы: WidgetFilter

settings Объединение
Возможные типы:
TableSettings

BoardSettings

PieChartSettings

BarChartSettings

ChartSettings

LineChartSettings

CalendarSettings

TimelineSettings

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetLayoutConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetLayoutConfig
dataSourceEntity DataSource

layout WidgetLayout

integrationInstance SpaceIntegrationInstance

id string

bums\spaces\api\v03\Entity\WidgetLayoutData

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetLayoutData
fields Коллекция

Возможные типы: LayoutDataField

aggregation Коллекция

Возможные типы: WidgetAggregation

aggregationCount integer

rows Коллекция

Возможные типы: WidgetLayoutDataRow

rowsCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetLayoutDataRow

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetLayoutDataRow
data Коллекция

Возможные типы: WidgetLayoutDataRowData

dataCount integer

url string

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetLayoutDataRowData

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetLayoutDataRowData
field string

value Объединение
Возможные типы:
string

boolean

Number

SpaceMoney

Ref

Select

User

SpaceFile

RefList

DateTime

DateOnly

SpaceDateInterval

SpaceStatus

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetLayoutGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetLayoutGroup
value Объединение
Возможные типы:
DateTime

Ref

SpaceStatus

User

WidgetGroupEmpty

QuarterGroupValue

WeekGroupValue

MonthGroupValue

YearGroupValue

DateOnly

Select

count integer

aggregationResults Коллекция

Возможные типы: AggregationResult

rows Коллекция

Возможные типы: WidgetLayoutDataRow

rowsCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\WidgetSort

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetSort
field string

direction string

Возможные варианты: asc, desc

bums\spaces\api\v03\Entity\WidgetSortConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен WidgetSortConfig
type string

Возможные варианты: auto, custom

sortBy Коллекция

Возможные типы: WidgetSort

bums\spaces\api\v03\Entity\Widget\Config\InfoGraphics\InfoGraphicsConfig

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InfoGraphicsConfig
layouts Коллекция

Возможные типы: InfoGraphicsLayout

layoutsCount integer

dataSets Коллекция

Возможные типы: InfoGraphicsDataSet

dataSetsCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\Widget\Config\InfoGraphics\InfoGraphicsDataSet

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InfoGraphicsDataSet
name string

dataSource string

groupBy WidgetGroup

aggregation WidgetAggregation

filters Коллекция

Возможные типы: WidgetFilter

filtersCount integer

id string

Идентификатор

bums\spaces\api\v03\Entity\Widget\Config\InfoGraphics\InfoGraphicsGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InfoGraphicsGroup
group Объединение
Возможные типы:
DateTime

Ref

SpaceStatus

User

WidgetGroupEmpty

QuarterGroupValue

WeekGroupValue

MonthGroupValue

YearGroupValue

DateOnly

Select

bums\spaces\api\v03\Entity\Widget\Config\InfoGraphics\InfoGraphicsLayout

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InfoGraphicsLayout
name string

type string

Возможные варианты: BarChart, PieChart, LineChart, Chart

id string

Идентификатор

bums\staff\api\v03\Controller\Request\productivity\ProductivityInterval

Описание

НУЖНО ТОЛЬКО ДЛЯ ТИПИЗАЦИИ - быстро фикс (надо удалять)

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProductivityInterval
interval string

Возможные варианты: now, this_day, this_week, this_month, this_year

bums\staff\api\v03\Controller\Request\productivity\type\CommentProductivityType

bums\staff\api\v03\Controller\Request\productivity\type\ContractorProductivityType

bums\staff\api\v03\Controller\Request\productivity\type\DealProductivityType

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealProductivityType
program Program

bums\staff\api\v03\Controller\Request\productivity\type\PriceProductivityType

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PriceProductivityType
program Program

bums\staff\api\v03\Controller\Request\productivity\type\TaskProductivityType

bums\staff\api\v03\Controller\Request\productivity\type\TodoProductivityType

bums\staff\api\v03\Controller\Request\productivity\type\UserOnlineProductivityType

bums\staff\api\v03\Entity\Anonymous

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Anonymous
userId string

Значение

id string

Идентификатор

bums\staff\api\v03\Entity\Bonus

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Bonus
from Employee

to Employee

value* Объединение
Возможные типы:
Morality

Money

Вид

type* string

Возможные варианты: bonus, fine

Тип

comment string

id string

Идентификатор

bums\staff\api\v03\Entity\CanLoginEmployeesCountRestriction

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CanLoginEmployeesCountRestriction
isEnabled boolean

possibleNewEmployeesCount integer

bums\staff\api\v03\Entity\Department

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Department
name string

id string

Идентификатор

bums\staff\api\v03\Entity\Desktop\DesktopWidgetMetaData

Описание

Сущность метаданных виджета

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DesktopWidgetMetaData
title string

categories Коллекция

Возможные типы: string

scale string

id string

Идентификатор

bums\staff\api\v03\Entity\Desktop\ExampleDesktopWidget

Описание

Простая сущность виджета

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ExampleDesktopWidget
posX* integer

posY* integer

title string

Заголовок/название виджета

scale string

Возможные варианты: compact, iconic, spacious, free

Масштаб: компактный, портретный, просторный, свободный

id string

Идентификатор

bums\staff\api\v03\Entity\EmployeeBirthdayDesktopWidget

Описание

Сущность виджета "Дни рождения"

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmployeeBirthdayDesktopWidget
scale string

posX* integer

posY* integer

title string

Заголовок/название виджета

id string

Идентификатор

bums\staff\api\v03\Entity\EmployeeEffectivenessDesktopWidget

Описание

Сущность виджета "Результативность"

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmployeeEffectivenessDesktopWidget
scale string

posX* integer

posY* integer

title string

Заголовок/название виджета

id string

Идентификатор

bums\staff\api\v03\Entity\EmployeeFireInfo

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmployeeFireInfo
chief Employee

Начальник увольняемого сотрудника

responsibleTasksCount integer

Задач, где сотрудник является ответственным

ownTasksCount integer

Задач, где сотрудник является постановщиком

soexecTasksCount integer

Задач, где сотрудник является соисполнителем

auditedTasksCount integer

Задач, где сотрудник является аудитором

responsibleProjectsCount integer

Проектов, где сотрудник является ответственным

ownProjectsCount integer

Проектов, где сотрудник является постановщиком

soexecProjectsCount integer

Проектов, где сотрудник является соисполнителем

auditedProjectsCount integer

Проектов, где сотрудник является аудитором

templateAuthorIssuesCount integer

Шаблонов, где сотрудник является автором

templateUserIssuesCount integer

Шаблонов, где сотрудник является участником

department string

Название отдела, где сотрудник является начальником

requestedVacationsCount integer

Неутвержденных отпусков

contractorsCount integer

Контрагентов, по которым сотрудник является единственным ответственным

ownRolesCount integer

Ролей в схемах сделок

ownDealsCount integer

Создано сделок

asAuditorDealsCount integer

Сделок, где сотрудник является аудитором

asManagerDealsCount integer

Сделок, где сотрудник является менеджером

ownCommunicationsCount integer

Коммуникаций, где сотрудник является участником

respCommunicationsCount integer

Коммуникаций, где сотрудник является ответственным

ownReportsCount integer

Отчетов, где сотрудник является создателем

respReportsCount integer

Отчетов, где сотрудник является участником

availableDocsCount integer

Документов, к которым у сотрудника есть доступ

ownInvoicesCount integer

Счетов, где сотрудник является автором

ownProgramsCount integer

Количество схем, где сотрудник участвует в роли

isTradeDirector boolean

Является директором по продажам

hasTradeRights boolean

Есть доступ к настройкам сделок

ownFilterCount integer

Фильтров, где сотрудник является создателем

ownGroupFilterCount integer

Группа фильтров, где сотрудник является создателем

bums\staff\api\v03\Entity\EmployeeImport

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmployeeImport
status string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

previousStatus string

Возможные варианты: parsing, parsed, validating, validated, saving, saved, error

approveStatusText string

error string

file File

Файл для парсинга

columns Коллекция

Возможные типы: ImportColumn

columnsCount integer

rows Коллекция

Возможные типы: ImportRow

rowsCount integer

includeAllRows boolean

Включает/выключает все строки

validRowsCount integer

Количество отвалидированных (включенных) строк, которые будут сохранены

maxColumnsCountInRows integer

Максимальное количество колонок в строках текущей сессии

includedRows Коллекция

Возможные типы: ImportRow

includedRowsCount integer

invalidatedRows Коллекция

Возможные типы: ImportRow

Строки, которые не будут загружены из-за ошибок

invalidatedRowsCount integer

errorRows Коллекция

Возможные типы: ImportRow

Строки в которых есть критичные и не критичные ошибки, часть из них может быть загружена

errorRowsCount integer

supressNotifications boolean

savedRowsCount integer

Количество сохраненных строк

loadingProgress integer

Прогресс обработки строк в процентах

id string

Идентификатор

bums\staff\api\v03\Entity\EmployeeStatus

Описание

Сущность для хранения статуса

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EmployeeStatus
name string

Название

masterType string

Возможные варианты: in-office, out-of-office

id string

Идентификатор

bums\staff\api\v03\Entity\GoogleSyncSetting

Описание

Сущность для хранения настроек синхронизации с Google календарем

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен GoogleSyncSetting
calendarId string

Ид календаря

calendarName string

Имя календаря

userEmail string

Почта пользователя

isDropped boolean

Удалена

isReadOnly boolean

Только для чтения

lastSyncDateTime DateTime

Дата последней синхронизации

id string

Идентификатор

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InviteLink
uuid string

enabled boolean

employees Коллекция

Возможные типы: Employee

employeesCount integer

id string

Идентификатор

bums\staff\api\v03\Entity\InviteLinkRegistration

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InviteLinkRegistration
uuid* string

lastName* string

firstName* string

email* string

password* string

photoRawBase64 string

Строка с содержимым файла, закодированным в base64

bums\staff\api\v03\Entity\InvitedEmployee

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InvitedEmployee
firstName string

lastName string

mail string

rawString string

parsed boolean

exists boolean

bums\staff\api\v03\Entity\Morality

Описание

Сущность для хранения значения морального бонуса

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Morality
value integer

Значение

bums\staff\api\v03\Entity\PasswordComplexity

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PasswordComplexity
message string

Текстовое описание сложности

complexity integer

Сложность пароля

minimalComplexity integer

Минимальная сложность пароля

bums\staff\api\v03\Entity\Position

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Position
name string

id string

Идентификатор

bums\staff\api\v03\Entity\Productivity\Productivity

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Productivity
segmentationValue integer

counters Коллекция

Возможные типы: ProductivityCounter

bums\staff\api\v03\Entity\Productivity\ProductivityCounter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProductivityCounter
name string

value Объединение
Возможные типы:
string

integer

bums\staff\api\v03\Entity\Vacation

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Vacation
name string

employee Employee

Сотрудник, запланировавший отпуск

firstDay DateOnly

Первый день отпуска

lastDay DateOnly

Последний день отпуска

type string

Тип отпуска

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

bums\task\project\api\v03\Entity\Project

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Project
status string

Возможные варианты: created, assigned, accepted, done, completed, rejected, cancelled, expired, delayed, template, overdue

Статус

tasks Коллекция

Возможные типы:

Task

Project

tasksCount integer

subProjects Коллекция

Возможные типы: Project

subProjectsCount integer

rights ProjectRights

Список возможных действий

possibleActions Коллекция

Возможные типы: string

Список возможных действий (Устаревшее)

parents Коллекция

Возможные типы: Project

parent Project

issues Коллекция

Возможные типы:

Task

Project

issuesCount integer

actualIssuesCount integer

messagesCount integer

interactionsCounters Коллекция

Возможные типы: InteractionCounter

workedOffTimeTotal DateInterval

Общее отработанное время

humanNumber integer

Человекочитаемый номер

name* string

Название

subject string

Описание задачи

isTemplate* boolean

Является шаблоном

originalTemplate Project

Оригинальный шаблон

templateUsers Коллекция

Возможные типы:

Employee

Group

Пользователи шаблона

templateUsersCount integer

Количество пользователей шаблона

templateViewers Коллекция

Возможные типы:

Employee

Group

Могут видеть шаблон и создавать сущности по нему

templateViewersCount integer

Количество видящих шаблон

isTemplateOwnerCurrentUser boolean

Владелец текущий пользователь

owner Employee

Владелец (Создатель)

responsible Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Ответственный

deadline Объединение
Возможные типы:
DateTime

DateOnly

ShiftDate

Дата дедлайна

deadlineReminders Коллекция

Возможные типы: Reminder

Напоминания о неизбежном дедлайне

deadlineRemindersCount integer

Количество напоминаний о дедлайне

isOverdue boolean

Просрочена

activity DateTime

Дата активности

auditors Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Аудиторы

auditorsCount integer

Количество аудиторов

executors Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Соисполнители

executorsCount integer

Количество соисполнителей

participants Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Участники

participantsCount integer

Количество участников

completed integer

Выполнено

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

statement string

Текст задачи

textStatement string

Человекочитаемый текст задачи

actualFinish DateTime

Дата финиша задачи (закрытия)

plannedFinish DateTime

Планируемое время окончания

duration DateInterval

Планируемая длительность задачи

responsibleCanEditExtFields boolean

Ответственные могут редактировать расширенные поля

executorsCanEditExtFields boolean

Соисполнители могут редактировать расширенные поля

auditorsCanEditExtFields boolean

Аудиторы могут редактировать расширенные поля

actualWork DateInterval

Актуальное время в мс

relationLinks Коллекция

Возможные типы: RelationLink

Связанные ссылки

relationLinksCount integer

Количество связанных ссылок

linksCount integer

Количество связанных ссылок

allFiles Коллекция

Возможные типы:

File

FileGroup

Список вложений

allFilesCount integer

Количество вложений

milestones Коллекция

Возможные типы: Milestone

Вехи

milestonesCount integer

Количество вех

deals Коллекция

Возможные типы: Deal

Сделки

dealsCount integer

Количество сделок

actualDealsCount integer

Количество актуальных сделок

plannedWork DateInterval

Планируемое время в мс

deadlineChangeRequest DeadlineChangeRequest

Запрос на изменение дедлайна

contractor Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Заказчик

timeCreated DateTime

Дата создания задачи (только чтение)

actualStart DateTime

Дата старта задачи (создания или принятия)

parentsCount integer

Количество родительских сущностей

statusChangeTime DateTime

Время последнего изменения статуса

entitiesByTemplate Коллекция

Возможные типы: Project

Сущности по шаблону

entitiesByTemplateCount integer

Количество сущностей по шаблону

actualEntitiesByTemplateCount integer

Актуальное количество сущностей по шаблону

isFavorite boolean

Избранный

lastComment Comment

Последний комментарий

lastCommentTimeCreated DateTime

Дата последнего комментария

commentsWithoutTransportCount integer

Количество комментариев без транспорта

editableFields Коллекция

Возможные типы: string

Поля доступные для редактирования

kpiStart number

KPI Начальное значение

kpiPlanned number

KPI Планируемое значение

kpiActual number

KPI Фактическое значение

kpiUnit string

KPI Единица измерения

kpiPercentage number

KPI Процент выполнения

calculatedFields Коллекция

Возможные типы: CalculatedField

Поля автоматизации

calculatedFieldsCount integer

Количество полей автоматизации

id string

Идентификатор

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

lastView DateTime

Дата последнего просмотра

tags Коллекция

Возможные типы: Tag

Метки

tagsCount integer

Количество меток

reminderTime DateTime

Дата напоминания

financeOperations Коллекция

Возможные типы: FinOperation

Финансовые операции

financeOperationsCount integer

Количество финансовых операций

attachesInfo AttachesInfo

Информация о вложении

emailsCount integer

Количество емейлов

whatsappCount integer

Количество сообщений whatsapp

telegramCount integer

Количество сообщений telegram

instagramCount integer

Количество сообщений instagram

todos Коллекция

Возможные типы: Todo

Массив дел

todosCount integer

Количество дел

actualTodosCount integer

Количество актуальных дел

finishedTodosCount integer

Количество завершенных дел

bums\task\project\api\v03\Entity\ProjectActionRequest

Описание

Сущность, определяющая запрос на выполнение действия над задачей

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProjectActionRequest
action* string

Возможные варианты: act_accept_work, act_reject_work, act_done, act_pause, act_resume, act_cancel, act_expire, act_renew, act_delete

Действие

text string

checkTodos boolean

Нужна ли проверка на незавершенные дела

bums\task\project\api\v03\Entity\ProjectRights

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProjectRights
read boolean

edit boolean

remove boolean

acceptWork boolean

rejectWork boolean

acceptDeadline boolean

rejectDeadline boolean

changeDeadline boolean

requestDeadline boolean

createTask boolean

createNegotiationTask boolean

createSubproject boolean

editExecutors boolean

editExtFields boolean

readMilestone boolean

createMilestone boolean

createFinOperation boolean

convert boolean

readBonuses boolean

linkDeal boolean

useTemplate boolean

toTemplate boolean

changeOwner boolean

pause boolean

resume boolean

cancel boolean

expire boolean

done boolean

renew boolean

reminderRecipient boolean

id string

Идентификатор

bums\task\task\api\v03\Controller\Request\filters\TaskResultTypeFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TaskResultTypeFilter
types Коллекция

Возможные типы: string

Возможные варианты: active, completed

bums\task\task\api\v03\Entity\DeadlineChangeRequest

Описание

Запрос изменения дедлайна

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DeadlineChangeRequest
owner Employee

Автор

issue* Объединение
Возможные типы:
Task

Project

Родительская сущность

deadline* Объединение
Возможные типы:
DateTime

DateOnly

Запрашиваемое значение дедлайна

status string

Возможные варианты: created, accepted, rejected, cancelled

Статус

type string

Возможные варианты: report, reminder, note

Тип

timeCreated* DateTime

Дата создания

timeUpdated DateTime

Дата изменения

whoUpdated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Автор изменения

request string

Причина изменения

id string

Идентификатор

bums\task\task\api\v03\Entity\Milestone

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Milestone
name string

Название

description* string

Описание вехи

completed boolean

Признак завершенности вехи

owner Employee

Создатель вехи

responsible Employee

Ответственный за веху (поле Reporter в модели)

type* string

Возможные варианты: report, reminder, note

Тип вехи

date* DateTime

Дата и время вехи

task Task

Задача

project Project

Проект

reminder Reminder

Напоминание

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_milestone_edit

Возможные действия

id string

Идентификатор

bums\task\task\api\v03\Entity\NegotiationItem

Описание

Согласование

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NegotiationItem
task Task

Задача

userCreated Employee

Создатель

userUpdated Employee

Обновил

timeUpdated DateTime

Дата обновления

timeCreated DateTime

Дата создания

versions Коллекция

Возможные типы: NegotiationItemVersion

Версии

versionsCount integer

Количество версий

actualVersion NegotiationItemVersion

Актуальная версия

id string

Идентификатор

bums\task\task\api\v03\Entity\NegotiationItemVersion

Описание

Версия согласования

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NegotiationItemVersion
negotiationItem NegotiationItem

Согласование

attache File

Вложение

text string

Текст

userCreated Employee

Создатель

timeCreated DateTime

Время создания

visas Коллекция

Возможные типы: NegotiationVisa

Визирование

visasCount integer

Количество визирований

status string

Возможные варианты: ok, bad, not_rated

Статус

id string

Идентификатор

bums\task\task\api\v03\Entity\NegotiationVisa

Описание

Визирование согласования

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NegotiationVisa
version NegotiationItemVersion

Версия

status string

Возможные варианты: ok, bad, not_rated

Статус

comment Comment

Комментарий

userCreated Employee

Создатель

timeCreated DateTime

Дата создания

id string

Идентификатор

bums\task\task\api\v03\Entity\Task

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Task
isUrgent* boolean

Горящая

isNegotiation boolean

Согласование

negotiationItems Коллекция

Возможные типы: NegotiationItem

Массив согласований

negotiationItemsCount integer

Количество согласований

negotiationExecutors Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Соисполнители задачи на согласование (включая участников из групп)

negotiationExecutorsCount integer

Количество соисполнителей задачи на согласование

status string

Возможные варианты: created, assigned, accepted, done, completed, rejected, cancelled, expired, delayed, template, overdue

Статус

previousTasks Коллекция

Возможные типы: Task

Предыдущие задачи

previousTasksCount integer

Количество предыдущих задач

nextTasksCount integer

Количество следующих задач

parents Коллекция

Возможные типы:

Task

Project

Массив надзадач/надпроектов

project Project

Корневой проект

rights TaskRights

Список возможных действий

possibleActions Коллекция

Возможные типы: string

Список возможных действий (Устаревшее)

parent Объединение
Возможные типы:
Task

Project

Надзадача/надпроект

subTasks Коллекция

Возможные типы: Task

Список подзадач

subTasksCount integer

Число подзадач

actualSubTasksCount integer

Число актуальных подзадач

bonuses Коллекция

Возможные типы: Bonus

Массив бонусов

fine Коллекция

Возможные типы: Bonus

Массив штрафов

fineCount integer

Количество штрафов

bonusesCount integer

Количество бонусов

isGroup boolean

Массовая задача

isGrouped boolean

Является частью массовой задачи

schedule Schedule

Событие

workedOffTime Коллекция

Возможные типы: Comment

Отработанное время

workedOffTimeCount integer

Количество элементов "Отработанное время"

workedOffTimeTotal DateInterval

Общее отработанное время

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

Создатель

finalRating number

Финальный рейтинг

messagesCount integer

Количество сообщений

interactionsCounters Коллекция

Возможные типы: InteractionCounter

decision boolean

visaOkCount integer

visaBadCount integer

shouldVisasCount integer

humanNumber integer

Человекочитаемый номер

name* string

Название

subject string

Описание задачи

isTemplate* boolean

Является шаблоном

originalTemplate Task

Оригинальный шаблон

templateUsers Коллекция

Возможные типы:

Employee

Group

Пользователи шаблона

templateUsersCount integer

Количество пользователей шаблона

templateViewers Коллекция

Возможные типы:

Employee

Group

Могут видеть шаблон и создавать сущности по нему

templateViewersCount integer

Количество видящих шаблон

isTemplateOwnerCurrentUser boolean

Владелец текущий пользователь

owner Employee

Владелец (Создатель)

responsible Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Ответственный

deadline Объединение
Возможные типы:
DateTime

DateOnly

ShiftDate

Дата дедлайна

deadlineReminders Коллекция

Возможные типы: Reminder

Напоминания о неизбежном дедлайне

deadlineRemindersCount integer

Количество напоминаний о дедлайне

isOverdue boolean

Просрочена

activity DateTime

Дата активности

auditors Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Аудиторы

auditorsCount integer

Количество аудиторов

executors Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Соисполнители

executorsCount integer

Количество соисполнителей

participants Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

Участники

participantsCount integer

Количество участников

completed integer

Выполнено

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

statement string

Текст задачи

textStatement string

Человекочитаемый текст задачи

actualFinish DateTime

Дата финиша задачи (закрытия)

plannedFinish DateTime

Планируемое время окончания

duration DateInterval

Планируемая длительность задачи

responsibleCanEditExtFields boolean

Ответственные могут редактировать расширенные поля

executorsCanEditExtFields boolean

Соисполнители могут редактировать расширенные поля

auditorsCanEditExtFields boolean

Аудиторы могут редактировать расширенные поля

actualWork DateInterval

Актуальное время в мс

relationLinks Коллекция

Возможные типы: RelationLink

Связанные ссылки

relationLinksCount integer

Количество связанных ссылок

linksCount integer

Количество связанных ссылок

allFiles Коллекция

Возможные типы:

File

FileGroup

Список вложений

allFilesCount integer

Количество вложений

milestones Коллекция

Возможные типы: Milestone

Вехи

milestonesCount integer

Количество вех

deals Коллекция

Возможные типы: Deal

Сделки

dealsCount integer

Количество сделок

actualDealsCount integer

Количество актуальных сделок

plannedWork DateInterval

Планируемое время в мс

deadlineChangeRequest DeadlineChangeRequest

Запрос на изменение дедлайна

contractor Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Заказчик

timeCreated DateTime

Дата создания задачи (только чтение)

actualStart DateTime

Дата старта задачи (создания или принятия)

parentsCount integer

Количество родительских сущностей

statusChangeTime DateTime

Время последнего изменения статуса

entitiesByTemplate Коллекция

Возможные типы: Task

Сущности по шаблону

entitiesByTemplateCount integer

Количество сущностей по шаблону

actualEntitiesByTemplateCount integer

Актуальное количество сущностей по шаблону

isFavorite boolean

Избранный

lastComment Comment

Последний комментарий

lastCommentTimeCreated DateTime

Дата последнего комментария

commentsWithoutTransportCount integer

Количество комментариев без транспорта

editableFields Коллекция

Возможные типы: string

Поля доступные для редактирования

kpiStart number

KPI Начальное значение

kpiPlanned number

KPI Планируемое значение

kpiActual number

KPI Фактическое значение

kpiUnit string

KPI Единица измерения

kpiPercentage number

KPI Процент выполнения

calculatedFields Коллекция

Возможные типы: CalculatedField

Поля автоматизации

calculatedFieldsCount integer

Количество полей автоматизации

id string

Идентификатор

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

lastView DateTime

Дата последнего просмотра

tags Коллекция

Возможные типы: Tag

Метки

tagsCount integer

Количество меток

reminderTime DateTime

Дата напоминания

financeOperations Коллекция

Возможные типы: FinOperation

Финансовые операции

financeOperationsCount integer

Количество финансовых операций

attachesInfo AttachesInfo

Информация о вложении

emailsCount integer

Количество емейлов

whatsappCount integer

Количество сообщений whatsapp

telegramCount integer

Количество сообщений telegram

instagramCount integer

Количество сообщений instagram

todos Коллекция

Возможные типы: Todo

Массив дел

todosCount integer

Количество дел

actualTodosCount integer

Количество актуальных дел

finishedTodosCount integer

Количество завершенных дел

bums\task\task\api\v03\Entity\TaskActionRequest

Описание

Запрос на выполнение действия над задачей

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TaskActionRequest
action* string

Возможные варианты: update_deep_last_activity, act_accept_task, act_reject_task, act_accept_work, act_reject_work, act_done, act_pause, act_resume, act_cancel, act_expire, act_edit, act_delete, act_accept_deadline, act_reject_deadline, act_renew, act_convert, act_delegate, act_takeup

Действие

text string

nextTasksStatus string

Возможные варианты: created, assigned, accepted, done, completed, rejected, cancelled, expired, delayed, template, overdue

Статус, в который будут переключены следующие задачи

checkTodos boolean

Нужна ли проверка на незавершенные дела

bums\task\task\api\v03\Entity\TaskDesktopWidget

Описание

Виджет "Задачи"Class TaskWidget

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TaskDesktopWidget
filterId string

posX* integer

posY* integer

title string

Заголовок/название виджета

scale string

Возможные варианты: compact, iconic, spacious, free

Масштаб: компактный, портретный, просторный, свободный

id string

Идентификатор

bums\task\task\api\v03\Entity\TaskRights

Описание

Права на задачу

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TaskRights
read boolean

Чтение

edit boolean

Редактирование

remove boolean

Удаление

updateDeepLastActivity boolean

Обновление последней активности

acceptWork boolean

Принятие в работу

rejectWork boolean

Отклонение работы

acceptTask boolean

Принятие задачи

rejectTask boolean

Отклонение задачи

acceptDeadline boolean

Принятие дедлайна

rejectDeadline boolean

Отклонение дедлайна

changeDeadline boolean

Изменение дедлайна

requestDeadline boolean

Запрос дедлайна

createSubtask boolean

Создание подзадачи

createNegotiationSubtask boolean

Создание подзадачи-согласования

editExecutors boolean

Редактирование соисполнителей

editExtFields boolean

Редактирование дополнительных полей

readMilestone boolean

Чтение вех

createMilestone boolean

Создание вех

createFinOperation boolean

Создание финансовых операций

convert boolean

Конвертирование

delegate boolean

Делегирование

readBonuses boolean

Чтение бонусов

linkDeal boolean

Связывание сделок

takeup boolean

Забрать задачу (назначить себя ответственным)

useTemplate boolean

Использование шаблонов

toTemplate boolean

К шаблону

changeOwner boolean

Смена владельца

pause boolean

Пауза

resume boolean

Продолжение

cancel boolean

Отмена

expire boolean

Истек

done boolean

Завершение

renew boolean

Возобновление

rateVoteAvailable boolean

Выставление оценки

rateVoteWillBeAvailable boolean

Выставление оценки будет доступно

rateResultsAvailable boolean

Результаты оценки

rateCustomVoteAvailable boolean

Кастомные значения оценок

rateChangeVoteAvailable boolean

Изменение собственных оценок после голосования

rateSeeVote boolean

Видимость своих результатов голосования

rateWidgetAvailable boolean

Блок с оценками

reminderRecipient boolean

Является получателем уведомлений

editMainInfo boolean

Может редактировать суть и название задачи

changeContractor boolean

Может редактировать заказчика

addNewNegotiationItem boolean

Можно ли добавить новый материал для согласования

deleteNegotiationItem boolean

Можно ли удалить материал для согласования

editNegotiationItemVersion boolean

Можно ли изменить материал для согласования

id string

Идентификатор

bums\time\api\v03\Controller\Requests\Filters\TodoDateTimeFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoDateTimeFilter
year* number

Год

month* number

Месяц

day number

День

bums\time\api\v03\Entity\TodoDesktopWidget

Описание

Виджет "Дела"

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TodoDesktopWidget
period string

posX* integer

posY* integer

title string

Заголовок/название виджета

scale string

Возможные варианты: compact, iconic, spacious, free

Масштаб: компактный, портретный, просторный, свободный

id string

Идентификатор

bums\trade\api\v03\Controller\Requests\Filters\DealProgramsFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealProgramsFilter
programs Коллекция

Возможные типы: Program

bums\trade\api\v03\Controller\Requests\Filters\DealResultTypeFilter

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealResultTypeFilter
types Коллекция

Возможные типы: string

Возможные варианты: active, negative, positive

bums\trade\api\v03\Entity\DealAspectDelivery

Описание

Энтити доставки.

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealAspectDelivery
description string

address Address

type DeliveryType

date DateOnly

cost Money

field RefLinkField

id string

Идентификатор

bums\trade\api\v03\Entity\DealDesktopWidget

Описание

Маппер виджета "Сделки"

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealDesktopWidget
filterId string

programId string

posX* integer

posY* integer

title string

Заголовок/название виджета

scale string

Возможные варианты: compact, iconic, spacious, free

Масштаб: компактный, портретный, просторный, свободный

id string

Идентификатор

bums\trade\api\v03\Entity\DealStatusHistory

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealStatusHistory
fromStatus ProgramState

Статус, из которого был осуществлен переход

toStatus ProgramState

Статус, в который был осуществлен переход

fromStatusUpdated DateTime

toStatusUpdated DateTime

fromStatusUser Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

toStatusUser Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

id string

Идентификатор

bums\trade\api\v03\Entity\DealsByProgram

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealsByProgram
program Program

Схема сделки

count integer

Количество сделок в данной схеме

bums\trade\api\v03\Entity\DeliveryType

Описание

Сущность типа доставки

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DeliveryType
name string

id string

Идентификатор

bums\trade\api\v03\Entity\PayForm

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PayForm
name string

Название

value Discount

Значение

active boolean

Активный

isLegal boolean

Валидный

id string

Идентификатор

logic\stm\api\v03\Entity\BpmSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BpmSettings
pluralNames Коллекция

Возможные типы: PluralName

pluralNamesCount integer

gender string

withDuplicatesFinder boolean

slug string

logic\stm\api\v03\Entity\DealShortCardSettings

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DealShortCardSettings
mainField string

leftTitleField string

rightTitleField string

buttonType string

Возможные варианты: positions, todos, manager

showNumber boolean

logic\stm\api\v03\Entity\KanbanColumnInfo

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен KanbanColumnInfo
originalStatus ProgramState

isVisible boolean

dealsCount integer

totalCost Money

logic\stm\api\v03\Entity\OperationLog

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OperationLog
startTime DateTime

finishTime DateTime

operation string

message string

linkedModel BaseEntity

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\AddComment

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AddComment
comment Comment

askTitle string

required boolean

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\AskPayer

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AskPayer
payer Payer

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\ChangeStateOperation

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ChangeStateOperation
state ProgramState

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\Confirm

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Confirm
confirmed boolean

question string

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\CreateDeal

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateDeal
deal Deal

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\CreateFinOperation

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateFinOperation
finOperations Коллекция

Возможные типы: FinOperation

finOperationsCount integer

finDisableNegativeBalanceCheck boolean

autoLink boolean

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\CreateInvoice

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateInvoice
invoice Invoice

deadlineExpressionValue string

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\CreateTask

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CreateTask
task Task

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\SendLead

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SendLead
email string

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\Operation\UnsupportedOperation

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UnsupportedOperation
hrName string

needRuntimeParams boolean

Флаг того, что операции нужны данные от пользователя.Сама проверка проходит отдельно, при формировании списка операций, и если операция попала в список клиенту,то значение точно true, поэтому оно здесь и захардкожено.Кроме этого параметр выполняет важную роль - не дать операции стать "пустой сущностью", если нет никаких заданных параметров.Тогда маппер не вернет её из апи, а она нам нужна самим фактом своего наличия.

id string

Идентификатор

logic\stm\api\v03\Entity\PluralName

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PluralName
type string

Возможные варианты: many, few, one, other

name string

logic\stm\api\v03\Entity\ProgramGroup

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramGroup
id string

Идентификатор

logic\stm\api\v03\Entity\ProgramPluralForm

Описание

Названия инстансов бизнес-процессов

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramPluralForm
one string

few string

many string

other string

gender string

Возможные варианты: male, female, neuter

programsUsage Коллекция

Возможные типы: DealsByProgram

programsUsageCount integer

id string

Идентификатор

logic\stm\api\v03\Entity\ProgramPreset

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramPreset
id string

name string

path string

description string

descriptionPromo string

image string

inFolder string

active boolean

states Коллекция

Возможные типы: any

statesCount string

statuses Коллекция

Возможные типы: any

statusesCount string

logic\stm\api\v03\Entity\ProgramRole

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramRole
name string

Название роли

isMultiple boolean

Множественное значение

linkedField Объединение
Возможные типы:
BigIntField

BoolField

DateField

DateTimeField

DurationField

EnumField

ExternalSourceField

FloatField

MoneyField

RefLinkField

RefSetField

ResourceField

StringField

Связанное поле

valueContentTypes Коллекция

Возможные типы: string

Доступные контент типы для значения связанного поля

id string

Идентификатор

logic\stm\api\v03\Entity\Rule\Context\CurrentTimeRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CurrentTimeRule
interval IntervalTime

Для данного триггера используется только время, дата игнорируется

type string

logic\stm\api\v03\Entity\Rule\Context\CurrentUserRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CurrentUserRule
currentUser Коллекция

Возможные типы:

Employee

Variable

ProgramRole

type string

logic\stm\api\v03\Entity\Rule\Context\FieldValueChangedRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FieldValueChangedRule
fieldRule Объединение
Возможные типы:
BoolFieldRule

DateFieldRule

EnumFieldRule

MoneyFieldRule

NumberFieldRule

RefFieldRule

StringFieldRule

UnsupportedFieldRule

noChoiceComparison boolean

type string

logic\stm\api\v03\Entity\Rule\Context\InstanceCreatedRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен InstanceCreatedRule
type string

logic\stm\api\v03\Entity\Rule\Context\MailWasReadRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MailWasReadRule
type string

logic\stm\api\v03\Entity\Rule\Context\NewCommentRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NewCommentRule
author Коллекция

Возможные типы:

Employee

Group

Variable

type string

logic\stm\api\v03\Entity\Rule\Context\PaidRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен PaidRule
type string

logic\stm\api\v03\Entity\Rule\Context\ProgramStateChangedRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramStateChangedRule
type string

logic\stm\api\v03\Entity\Rule\Field\BoolFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен BoolFieldRule
value boolean

comparison string

Возможные варианты: equal

field string

logic\stm\api\v03\Entity\Rule\Field\DateFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateFieldRule
comparison string

Возможные варианты: setted, equal, greater, greater_or_equal, smaller, smaller_or_equal, interval

value Объединение
Возможные типы:
DateOnly

RuleIntervalDates

Variable

field string

logic\stm\api\v03\Entity\Rule\Field\EnumFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен EnumFieldRule
comparison string

Возможные варианты: setted, one_of

value Коллекция

Возможные типы: string

field string

logic\stm\api\v03\Entity\Rule\Field\MoneyFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен MoneyFieldRule
comparison string

Возможные варианты: setted, equal, greater, greater_or_equal, smaller, smaller_or_equal, interval

value Объединение
Возможные типы:
RuleIntervalMoney

Money

field string

logic\stm\api\v03\Entity\Rule\Field\NumberFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NumberFieldRule
field string

comparison string

Возможные варианты: setted, equal, greater, greater_or_equal, smaller, smaller_or_equal, interval

value Объединение
Возможные типы:
number

integer

IntervalNumbers

logic\stm\api\v03\Entity\Rule\Field\RefFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RefFieldRule
comparison string

Возможные варианты: setted, one_of

value Коллекция

Возможные типы:

BaseEntity

Variable

field string

logic\stm\api\v03\Entity\Rule\Field\RuleIntervalDates

Описание

Интервал дат для правил

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RuleIntervalDates
from Объединение
Возможные типы:
DateOnly

Variable

Дата начала

to Объединение
Возможные типы:
DateOnly

Variable

Дата завершения

logic\stm\api\v03\Entity\Rule\Field\RuleIntervalMoney

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен RuleIntervalMoney
from Money

to Money

logic\stm\api\v03\Entity\Rule\Field\StringFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен StringFieldRule
comparison string

Возможные варианты: setted, equal, contains

value string

field string

logic\stm\api\v03\Entity\Rule\Field\UnsupportedFieldRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен UnsupportedFieldRule
field string

logic\stm\api\v03\Entity\Rule\FormulaRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен FormulaRule
expression string

comparison string

Возможные варианты: setted, equal, greater, greater_or_equal, smaller, smaller_or_equal, interval

value Объединение
Возможные типы:
number

integer

IntervalNumbers

logic\stm\api\v03\Entity\Rule\NotRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен NotRule
rule Объединение
Возможные типы:
CurrentTimeRule

CurrentUserRule

FieldValueChangedRule

InstanceCreatedRule

MailWasReadRule

NewCommentRule

PaidRule

ProgramStateChangedRule

BoolFieldRule

DateFieldRule

EnumFieldRule

MoneyFieldRule

NumberFieldRule

RefFieldRule

StringFieldRule

UnsupportedFieldRule

FormulaRule

NotRule

ProgramStateRule

AndRule

OrRule

logic\stm\api\v03\Entity\Rule\ProgramStateRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramStateRule
state ProgramState

logic\stm\api\v03\Entity\Rule\Set\AndRule

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AndRule
children Коллекция

Возможные типы:

CurrentTimeRule

CurrentUserRule

FieldValueChangedRule

InstanceCreatedRule

MailWasReadRule

NewCommentRule

PaidRule

ProgramStateChangedRule

BoolFieldRule

DateFieldRule

EnumFieldRule

MoneyFieldRule

NumberFieldRule

RefFieldRule

StringFieldRule

UnsupportedFieldRule

FormulaRule

NotRule

ProgramStateRule

AndRule

OrRule

logic\stm\api\v03\Entity\Rule\Set\OrRule

Поля сущности

logic\stm\api\v03\Entity\TriggerLog

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TriggerLog
trigger ProgramTrigger

startTime DateTime

finishTime DateTime

user Employee

message string

operationLogs Коллекция

Возможные типы: OperationLog

operationLogsCount integer

id string

Идентификатор

logic\stm\api\v03\Entity\TriggerLogSet

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен TriggerLogSet
programInstance BaseEntity

InstanceMapper размапит это поле в Object

result string

Возможные варианты: success, fail, undefined

message string

rows Коллекция

Возможные типы: TriggerLog

rowsCount integer

user Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

timeCreated DateTime

id string

Идентификатор

Валюта

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Currency
name string

Название

abbreviation string

Аббревиатура

sign string

Знак

rate number

Курс

isBase boolean

Основная ли

id string

Идентификатор

Дата

Описание

Дата

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateOnly
year integer

Год

month integer

Месяц, отсчёт начинается с 0

day integer

День

Дата и время

Описание

Дата и время

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateTime
value* string

Дата и время в ISO 8601 формате

Деньги

Описание

Деньги

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Money
value* number

Значение

currency* string

ISO код валюты

valueInMain* number

Базовое значение

rate number

Курс

Единица измерений

Описание

Единица измерения

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Unit
name string

Единица измерения

id string

Идентификатор

Интервал

Описание

Интервал дат

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен DateInterval
seconds* integer

Количество секунд между двумя датами

Информация об аккаунте

Описание

Сущность без маппера и персистера.Собирается налету в своем контроллере.Инкапсулирует некоторую информацию об аккаунте.

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен AccountInfo
permanentHost string

Статичный хост присваивающийся аккаунту при создании.

accountName string

Название аккаунта

buildVersion string

Версия билда

productName string

Название тарифа

systemProductName string

Системное название тарифа (класс тарифа)

tarifId string

Ид тарифа (короткое представление, используемое в AccountTarif)

ecometHost string

Сервер вебсокета

ecometPort integer

Порт сервера вебсокета

ecometToken string

Токен текущего пользователя для подключения к вебсокету

licenceEndDate DateOnly

Срок действия лицензии

mobileEndDate DateOnly

Срок действия мобильного приложения

paidToDate DateOnly

Оплачен до

licenceQuantity integer

Число лицензий

paidLicenceQuantity integer

Число оплаченных лицензий

partnerId integer

Id партнера

licenseExpired boolean

Лицензия истекла

enabledModules Коллекция

Возможные типы: Module

Модули мегаплана

enabledModulesCount integer

isTest boolean

Является ли данная версия приложения тестовой

megamailDomain string

Домен аккаунта

caldavSyncs Коллекция

Возможные типы: IntegrationInfo

Внешние календари

caldavSyncsCount integer

Количество внешних календарей

isSaas boolean

Облачная версия

isFree boolean

Бесплатная версия

isDemo boolean

Является ли данная версия демо версией

defaultCountryCode integer

Дефолтное значение телефонного кода страны

daysRemaining integer

Дней до окончания лицензии

maxDiskSpace integer

Максимальное дисковое пространство

usedMemory integer

Занятое дисковое пространство

timeCreated DateTime

jivoId string

id аккаунта в JivoSite

cqHash string

hash для CarrotQuest

cqUserId string

UserId в CarrotQuest

id string

Идентификатор

Клиент-компания

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorCompany
contacts Коллекция

Возможные типы: ContractorHuman

Массив клиентов-физических лиц

contactsCount integer

Количество клиентов-физических лиц

position string

Должность

name* string

Название

promisingRate number

Перспективность

type ContractorType

responsibles Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

responsiblesCount integer

contactInfo Коллекция

Возможные типы:

ContactInfo

Address

contactInfoCount integer

description string

textDescription string

birthday DateOnly

preferTransport string

Возможные варианты: email, sms, skype, informer

advertisingWay ContractorAdvertisingWay

activityType ContractorActivityType

status ContractorStatus

partners Коллекция

Возможные типы:

ContractorCompany

ContractorHuman

partnersCount integer

competitors Коллекция

Возможные типы:

ContractorCompany

ContractorHuman

competitorsCount integer

payers Коллекция

Возможные типы: Payer

payersCount integer

isPublic boolean

attaches Коллекция

Возможные типы: File

attachesCount integer

linksCount integer

relationLinks Коллекция

Возможные типы: RelationLink

relationLinksCount integer

timeCreated DateTime

timeUpdated DateTime

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

userUpdated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

nextCommunicationDate Объединение
Возможные типы:
DateTime

DateOnly

nextCommunication Todo

lastCommunicationDate Объединение
Возможные типы:
DateTime

DateOnly

countCommunications integer

countScheduledCommunications integer

countOverdueCommunications integer

lastDealDate DateTime

countDeals integer

countActiveDeals integer

countPositiveDeals integer

countNegativeDeals integer

summDeals Money

summActiveDeals Money

summPositiveDeals Money

countInvoice integer

countNotPaidInvoice integer

summInvoice Money

summNotPaidInvoice Money

summAccountReceivable Money

summAccountReceivableOverdue Money

issuesCount integer

activeIssuesCount integer

inactiveIssuesCount integer

totalAttachesCount integer

lastComment Comment

lastCommentTimeCreated DateTime

balance Money

nextTaskDate DateTime

canSeeFull boolean

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_edit, act_read, message, task, add_item, add_deal, act_fake_drop, act_delete, act_restore, act_view_fin_operation, act_invite, act_attaches, read_full

Список возможных действий

isDropped boolean

Удален ли клиент

isFavorite boolean

Is it favorite for current user?

countBalance integer

consignmentsCount integer

messagesCount integer

callsCount integer

humanNumber integer

actualTodosCount integer

Количество актуальных дел

finishedTodosCount integer

Количество завершенных дел

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

allFiles Коллекция

Возможные типы:

File

FileGroup

Массив файлов

allFilesCount integer

Количество файлов

attachesInfo AttachesInfo

Информация о вложении

commentsWithoutTransportCount integer

Количество комментариев без транспорта

interactionsCounters Коллекция

Возможные типы: InteractionCounter

mergeInProgress boolean

Объединение клиентов с участием данного клиента еще не завершено

id string

Идентификатор

todos Коллекция

Возможные типы: Todo

Массив дел

todosCount integer

Количество дел

avatar File

photo File

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

lastView DateTime

Дата последнего просмотра

tags Коллекция

Возможные типы: Tag

Метки

tagsCount integer

Количество меток

reminderTime DateTime

Дата напоминания

emailsCount integer

Количество емейлов

whatsappCount integer

Количество сообщений whatsapp

telegramCount integer

Количество сообщений telegram

instagramCount integer

Количество сообщений instagram

Клиент-человек

Описание

Контактное лицо компании или клиент-физическое лицо

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorHuman
firstName string

Имя

middleName string

Отчество

lastName string

Фамилия

company Объединение
Возможные типы:
ContractorCompany

ContractorHuman

name string

gender string

Возможные варианты: male, female

position string

uid integer

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_edit, act_read, message, task, add_item, add_deal, act_fake_drop, act_delete, act_restore, act_view_fin_operation, act_invite, act_attaches, read_full, can_create_widgets, can_start_feature_test_drive, can_delete_the_account, can_create_application, can_install_application, can_edit_employees_settings, crm_enter, crm_add, crm_loyalty, crm_sending, crm_leadforms, employee_enter, employee_add, employee_salary, employee_bonus, employee_structure, employee_relation, employee_vacation, employee_report, employee_groups, employee_filter_export, fin_operation, fin_operation_add, fin_report, fin_settings, deal_enter, deal_add, act_create_deal, invoice_enter, invoice_add, offer_enter, offer_add, consignment_enter, doc_enter, doc_add, report_enter, report_add, report_sales_funnel, report_sales_department, discuss_enter, discuss_add, tasks_enter, tasks_add, tasks_delete, project_enter, project_admin, issues_templates_enter, todos_enter, todos_add, blog_news_read, certificate_enter, addons_enter, settings_setting_enter, settings_services_integration_eneter, settings_cards_enter, settings_deals_enter, settings_personal_setting_enter, settings_personal_setting_notifications, settings_setting_employees_rights, settings_setting_interface, settings_setting_system, settings_setting_account_security, settings_setting_menu_items, settings_setting_backup_management, settings_setting_transition_box, settings_setting_mailouts_mail_server, settings_setting_tasks, settings_file_storage_info, settings_services_integration_newsletters_and_notifications, settings_services_integration_email_communications, settings_services_integration_outcoming_email, settings_services_integration_reply_to_notifications, settings_services_integration_imap_integration, settings_services_integration_imap_integration_for_deals, settings_services_integration_rts_tender_integration, settings_services_integration_telephony, settings_cards_discussion_sections, settings_cards_countries, settings_cards_currencies, settings_cards_taxes, settings_cards_tasks_and_projects, settings_cards_tasks_custom_fields, settings_cards_projects_custom_fields, settings_cards_employees, settings_cards_positions, settings_cards_vacation_types, settings_cards_contractors, settings_cards_contractors_types, settings_cards_contractors_custom_fields, settings_cards_requisites, settings_cards_contractors_activity_types, settings_cards_advertising_ways, settings_cards_managers_rights, settings_cards_business_processes, settings_cards_sending, settings_cards_event_categories, settings_cards_events_statuses, settings_cards_events_places, settings_cards_invoice_templates, settings_cards_invoice_units, settings_cards_offers, settings_cards_offers_custom_fields, settings_deals_deals_programs, settings_deals_program_wizard, settings_deals_pay_forms, settings_deals_delivery_types, settings_deals_integrate, settings_deals_import_deals_from_email, settings_account_area, settings_staff_can_hide_menu_items, feature_new_task_list, feature_new_task_card, feature_new_project_card, feature_new_crm_list, feature_new_trade_card, feature_new_crm_card, feature_new_trade_list, feature_new_employee_list, feature_new_employee_card, feature_new_todo_list, feature_new_todo_card, feature_download_all, feature_new_topic_list, trade_filter_export, crm_filter_export, crm_view_onboarding_hint, task_filter_export, offer_filter_export, task_tags_available, task_tags_available_in_add_form, task_todos_available, task_todos_available_in_add_form, task_attaches_available, task_attaches_available_in_add_form, project_tags_available, project_tags_available_in_add_form, project_todos_available, project_todos_available_in_add_form, project_attaches_available, project_attaches_available_in_add_form, can_use_telephony, can_hide_menu_items, can_enable_import_from_email_to_deals, settings_services_integration_b24, feature_new_document_card, feature_new_document_list, settings_files, workspaces_beta_feature

список доступных контрактору действий

dateLastReadNews string

дата когда в последний раз читал новости в блоге

isGuestAccessEnabled boolean

loginEmail string

Почта для выдачи гостевого доступа

canLogin boolean

Может ли зайти в Мегаплан

lastOnline Объединение
Возможные типы:
DateTime

string

Когда последний раз заходил

settings Коллекция

Возможные типы:

SystemSetting

UserSetting

settingsCount integer

contacts Коллекция

Возможные типы: ContractorHuman

Массив клиентов-физических лиц

contactsCount integer

Количество клиентов-физических лиц

type ContractorType

responsibles Коллекция

Возможные типы:

Employee

ContractorCompany

ContractorHuman

Group

responsiblesCount integer

contactInfo Коллекция

Возможные типы:

ContactInfo

Address

contactInfoCount integer

description string

textDescription string

birthday DateOnly

preferTransport string

Возможные варианты: email, sms, skype, informer

advertisingWay ContractorAdvertisingWay

activityType ContractorActivityType

status ContractorStatus

partners Коллекция

Возможные типы:

ContractorCompany

ContractorHuman

partnersCount integer

competitors Коллекция

Возможные типы:

ContractorCompany

ContractorHuman

competitorsCount integer

payers Коллекция

Возможные типы: Payer

payersCount integer

isPublic boolean

attaches Коллекция

Возможные типы: File

attachesCount integer

linksCount integer

relationLinks Коллекция

Возможные типы: RelationLink

relationLinksCount integer

timeCreated DateTime

timeUpdated DateTime

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

userUpdated Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

nextCommunicationDate Объединение
Возможные типы:
DateTime

DateOnly

nextCommunication Todo

lastCommunicationDate Объединение
Возможные типы:
DateTime

DateOnly

countCommunications integer

countScheduledCommunications integer

countOverdueCommunications integer

lastDealDate DateTime

countDeals integer

countActiveDeals integer

countPositiveDeals integer

countNegativeDeals integer

summDeals Money

summActiveDeals Money

summPositiveDeals Money

countInvoice integer

countNotPaidInvoice integer

summInvoice Money

summNotPaidInvoice Money

summAccountReceivable Money

summAccountReceivableOverdue Money

issuesCount integer

activeIssuesCount integer

inactiveIssuesCount integer

totalAttachesCount integer

lastComment Comment

lastCommentTimeCreated DateTime

balance Money

nextTaskDate DateTime

canSeeFull boolean

isDropped boolean

Удален ли клиент

isFavorite boolean

Is it favorite for current user?

countBalance integer

consignmentsCount integer

messagesCount integer

callsCount integer

humanNumber integer

actualTodosCount integer

Количество актуальных дел

finishedTodosCount integer

Количество завершенных дел

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

allFiles Коллекция

Возможные типы:

File

FileGroup

Массив файлов

allFilesCount integer

Количество файлов

attachesInfo AttachesInfo

Информация о вложении

commentsWithoutTransportCount integer

Количество комментариев без транспорта

interactionsCounters Коллекция

Возможные типы: InteractionCounter

mergeInProgress boolean

Объединение клиентов с участием данного клиента еще не завершено

id string

Идентификатор

todos Коллекция

Возможные типы: Todo

Массив дел

todosCount integer

Количество дел

avatar File

photo File

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

lastView DateTime

Дата последнего просмотра

tags Коллекция

Возможные типы: Tag

Метки

tagsCount integer

Количество меток

reminderTime DateTime

Дата напоминания

emailsCount integer

Количество емейлов

whatsappCount integer

Количество сообщений whatsapp

telegramCount integer

Количество сообщений telegram

instagramCount integer

Количество сообщений instagram

Налог

Описание

Сущность налога

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Tax
name string

Название

rate number

Значение

id string

Идентификатор

Плательщик

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Payer
id string

Идентификатор

name string

Имя

type* string

Возможные варианты: Legal, Natural

Тип плательщика

country* Country

Страна плательщика

isDropped boolean

Удален

bank string

Банк плательщика

bik string

Бик плательщика

inn string

ИНН плательщика

edrpou string

ЕДРПОУ(ЕГРПОУ) плательщика

correspondentAccount string

Корреспондентский счёт плательщика

kpp string

КПП плательщика

ogrn string

ОГРН плательщика

firstName string

Имя плательщика

lastName string

Фамилия плательщика

address string

Адрес плательщика

legalAddress string

Юр адрес плательщика

currentAccount string

р/с (расчётный счёт) плательщика

mfo string

МФО плательщика

unp string

УНП плательщика

okpo string

ОКПО плательщика

contractor Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Контрагент

Позиция счета

Описание

Позиция счета

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен OfferRow
price Money

Цена

priceWithoutTax Money

Цена без НДС

name string

Название

quantity number

Количество

tax Tax

Налог

discount Discount

Скидка

margin Discount

Наценка

unit Unit

Единица измерения

description string

Описание

offer* Offer

Товар

sum Money

Общая сумма

sumWithoutTax Money

Общая сумма без НДС

taxSum Money

Сумма НДС

deal Deal

Сделка

offerCategory OfferCategory

Категория товара

id string

Идентификатор

Сделка

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Deal
isFavorite boolean

Избранный

number string

Номер

name string

Название

description string

Суть

shortDescription string

Краткое описание

lastComment Comment

Последний комментарий

lastCommentTimeCreated DateTime

Дата последнего комментария

contractor Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Клиент

contact Объединение
Возможные типы:
ContractorCompany

ContractorHuman

Контактное лицо

manager Объединение
Возможные типы:
Employee

ContractorHuman

Group

Менеджер

payer Payer

Плательщик

auditors Коллекция

Возможные типы:

Employee

ContractorHuman

Group

Список аудиторов

auditorsCount integer

Количество аудиторов

price Money

Общая сумма по сделке

cost Money

Предварительная стоимость

payForm PayForm

Форма оплаты

currency Currency

Валюта

timeCreated DateTime

Дата создания

timeUpdated DateTime

Дата обновления

state ProgramState

Текущий статус сделки

stateTimeUpdated DateTime

Время изменения статуса

result string

Возможные варианты: active, positive, negative

Результат сделки

positions Коллекция

Возможные типы: OfferRow

Список товаров или услуг в заказе

positionsCount integer

Количество товаров или услуг в заказе

consignment Consignment

Накладная

debt Money

Долг клиента

paymentProgress number

Прогресс оплаты в процентах

invoices Коллекция

Возможные типы: Invoice

Список выставленных счетов

invoicesCount integer

Количество выставленных счетов

nearTodo Todo

Ближайшее дело связанное со сделкой

program* Program

Схема сделки

possibleTriggers Коллекция

Возможные типы: ProgramTrigger

Список сценариев типа Кнопка, которые доступны в текущем статусе сделки

possibleTriggersCount integer

Количество сценариев типа Кнопка, которые доступны в текущем статусе сделки

possibleTransitions Коллекция

Возможные типы: ProgramTransition

Список переходов между статусами, которые доступны в текущем статусе сделки

possibleTransitionsCount integer

Количество переходов между статусами, которые доступны в текущем статусе сделки

possibleActions Коллекция

Возможные типы: string

Возможные варианты: act_read, act_delete, act_use_journal, act_add_consignment, act_edit_positions, act_produce

Список возможных действий

dealsCount integer

Количество связанных сделок

actualDealsCount integer

Количество активных связанных сделок

tasksCount integer

Количество связанных задач

actualTasksCount integer

Количество актуальны связанных задач

contractorPhone ContactInfo

Контактная информация контрагента

contractorEmail string

E-mail контрагента

visibleFields Коллекция

Возможные типы: string

Поля доступные для отображения

editableFields Коллекция

Возможные типы: string

Поля доступные для редактирования

messagesCount integer

Количество писем

callsCount integer

Количество звонков

linksCount integer

Количество связанных ссылок

relationLinks Коллекция

Возможные типы: RelationLink

Связанные ссылки

relationLinksCount integer

Количество связанных ссылок

userCreated Объединение
Возможные типы:
Employee

ContractorHuman

Group

Создатель

userUpdated Объединение
Возможные типы:
Employee

ContractorCompany

ContractorHuman

Group

Обновил

participantsCount integer

Количество участников

contractorFields Коллекция

Возможные типы: string

Поля контрагента

fixCurrencyDate DateTime

Дата изменения курса валюты

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

commentsWithoutTransportCount integer

Количество комментариев без транспорта

interactionsCounters Коллекция

Возможные типы: InteractionCounter

id string

Идентификатор

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

todos Коллекция

Возможные типы: Todo

Массив дел

todosCount integer

Количество дел

actualTodosCount integer

Количество актуальных дел

finishedTodosCount integer

Количество завершенных дел

allFiles Коллекция

Возможные типы:

File

FileGroup

Массив файлов

allFilesCount integer

Количество файлов

attachesInfo AttachesInfo

Информация о вложении

tags Коллекция

Возможные типы: Tag

Метки

tagsCount integer

Количество меток

reminderTime DateTime

Дата напоминания

financeOperations Коллекция

Возможные типы: FinOperation

Финансовые операции

financeOperationsCount integer

Количество финансовых операций

emailsCount integer

Количество емейлов

whatsappCount integer

Количество сообщений whatsapp

telegramCount integer

Количество сообщений telegram

instagramCount integer

Количество сообщений instagram

Сделка. Переход между статусами

Описание

Переход схемы сделки.

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramTransition
name string

Название перехода

description string

to ProgramState

Статус, в который перейдет сделка

from ProgramState

operation string

rule string

direction integer

enabled boolean

Доступно ли действие для запуска

reasons Коллекция

Возможные типы: string

Причина недоступности для запуска

operations Коллекция

Возможные типы:

AddComment

AskPayer

ChangeStateOperation

Confirm

CreateDeal

CreateFinOperation

CreateInvoice

CreateTask

SendLead

UnsupportedOperation

operationsCount integer

id string

Идентификатор

Сделка. Статус

Описание

Статус схемы сделки.

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramState
name string

Название статуса

entryPointName string

Название точки входа

description string

Описание статуса

type string

Возможные варианты: active, positive, negative

color string

isEntry boolean

program Program

id string

Идентификатор

Сделка. Схема сделки

Описание

Схема сделки

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Program
name string

Название схемы

states Коллекция

Возможные типы: ProgramState

Список статусов схемы

statesCount integer

Количество статусов схемы

transitions Коллекция

Возможные типы: ProgramTransition

Список переходов между статусами

transitionsCount integer

Количество переходов между статусами

triggers Коллекция

Возможные типы: ProgramTrigger

Список сценариев схемы

triggersCount integer

Количество сценариев схемы

dealShortCardSettings DealShortCardSettings

userDealShortCardSettings DealShortCardSettings

roles Коллекция

Возможные типы: ProgramRole

Роли программы

rolesCount integer

Количество ролей программы

fixedFields Коллекция

Возможные типы: string

Закрепленные поля

orderPositionsFields Коллекция

Возможные типы: string

Поля позиций в заказе

orderPositionsSortField SortField

Сортировка позиций по полю

possibleActions Коллекция

Возможные типы: string

Возможные варианты: can_create, can_export

Список возможных действий

isBpm boolean

Является ли программа бизнес процессом

bmpSettings BpmSettings

programGroup ProgramGroup

id string

Идентификатор

Сделка. Сценарий

Описание

Сценарий схемы сделки.

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ProgramTrigger
name string

Название сценария

program Program

params string

orderPosition integer

type string

Возможные варианты: auto, button, system, schedule

Тип операции

typeHr string

Человекочитабельный тип операции - "Кнопка" etc.

possibleOperations Коллекция

Возможные типы: string

paramsRequiredOperations Коллекция

Возможные типы:

AddComment

AskPayer

ChangeStateOperation

Confirm

CreateDeal

CreateFinOperation

CreateInvoice

CreateTask

SendLead

UnsupportedOperation

paramsRequiredOperationsCount integer

rule Объединение
Возможные типы:
CurrentTimeRule

CurrentUserRule

FieldValueChangedRule

InstanceCreatedRule

MailWasReadRule

NewCommentRule

PaidRule

ProgramStateChangedRule

BoolFieldRule

DateFieldRule

EnumFieldRule

MoneyFieldRule

NumberFieldRule

RefFieldRule

StringFieldRule

UnsupportedFieldRule

FormulaRule

NotRule

ProgramStateRule

AndRule

OrRule

enabled boolean

Доступно ли действие для запуска

reasons Коллекция

Возможные типы: string

Причина недоступности для запуска

operations Коллекция

Возможные типы:

AddComment

AskPayer

ChangeStateOperation

Confirm

CreateDeal

CreateFinOperation

CreateInvoice

CreateTask

SendLead

UnsupportedOperation

operationsCount integer

id string

Идентификатор

Системные настройки

Описание

Системные настройки

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен SystemSetting
id string

Идентификатор

scope string

Название скоупа настроек

value any

Значение настройки

Скидка на товар

Описание

Скидка на позицию в счете

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Discount
type string

Возможные варианты: percent, absolute

Тип скидки - конкретное число или проценты

valueInMain number

Значение в базовой валюте

Сотрудник

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Employee
firstName string

Имя

lastName string

Фамилия

middleName string

Отчество

name string

Имя

position string

uid integer

gender string

Возможные варианты: male, female

contactInfo* Коллекция

Возможные типы:

ContactInfo

Address

Контактная информация

address Address

Адрес

contactInfoCount integer

isWorking boolean

fireInProgress boolean

birthday DateOnly

inn string

age integer

possibleActions Коллекция

Возможные типы: string

Возможные варианты: can_create_widgets, can_start_feature_test_drive, can_delete_the_account, can_create_application, can_install_application, can_edit_employees_settings, crm_enter, crm_add, crm_loyalty, crm_sending, crm_leadforms, employee_enter, employee_add, employee_salary, employee_bonus, employee_structure, employee_relation, employee_vacation, employee_report, employee_groups, employee_filter_export, fin_operation, fin_operation_add, fin_report, fin_settings, deal_enter, deal_add, act_create_deal, invoice_enter, invoice_add, offer_enter, offer_add, consignment_enter, doc_enter, doc_add, report_enter, report_add, report_sales_funnel, report_sales_department, discuss_enter, discuss_add, tasks_enter, tasks_add, tasks_delete, project_enter, project_admin, issues_templates_enter, todos_enter, todos_add, blog_news_read, certificate_enter, addons_enter, settings_setting_enter, settings_services_integration_eneter, settings_cards_enter, settings_deals_enter, settings_personal_setting_enter, settings_personal_setting_notifications, settings_setting_employees_rights, settings_setting_interface, settings_setting_system, settings_setting_account_security, settings_setting_menu_items, settings_setting_backup_management, settings_setting_transition_box, settings_setting_mailouts_mail_server, settings_setting_tasks, settings_file_storage_info, settings_services_integration_newsletters_and_notifications, settings_services_integration_email_communications, settings_services_integration_outcoming_email, settings_services_integration_reply_to_notifications, settings_services_integration_imap_integration, settings_services_integration_imap_integration_for_deals, settings_services_integration_rts_tender_integration, settings_services_integration_telephony, settings_cards_discussion_sections, settings_cards_countries, settings_cards_currencies, settings_cards_taxes, settings_cards_tasks_and_projects, settings_cards_tasks_custom_fields, settings_cards_projects_custom_fields, settings_cards_employees, settings_cards_positions, settings_cards_vacation_types, settings_cards_contractors, settings_cards_contractors_types, settings_cards_contractors_custom_fields, settings_cards_requisites, settings_cards_contractors_activity_types, settings_cards_advertising_ways, settings_cards_managers_rights, settings_cards_business_processes, settings_cards_sending, settings_cards_event_categories, settings_cards_events_statuses, settings_cards_events_places, settings_cards_invoice_templates, settings_cards_invoice_units, settings_cards_offers, settings_cards_offers_custom_fields, settings_deals_deals_programs, settings_deals_program_wizard, settings_deals_pay_forms, settings_deals_delivery_types, settings_deals_integrate, settings_deals_import_deals_from_email, settings_account_area, settings_staff_can_hide_menu_items, feature_new_task_list, feature_new_task_card, feature_new_project_card, feature_new_crm_list, feature_new_trade_card, feature_new_crm_card, feature_new_trade_list, feature_new_employee_list, feature_new_employee_card, feature_new_todo_list, feature_new_todo_card, feature_download_all, feature_new_topic_list, trade_filter_export, crm_filter_export, crm_view_onboarding_hint, task_filter_export, offer_filter_export, task_tags_available, task_tags_available_in_add_form, task_todos_available, task_todos_available_in_add_form, task_attaches_available, task_attaches_available_in_add_form, project_tags_available, project_tags_available_in_add_form, project_todos_available, project_todos_available_in_add_form, project_attaches_available, project_attaches_available_in_add_form, can_use_telephony, can_hide_menu_items, can_enable_import_from_email_to_deals, settings_services_integration_b24, feature_new_document_card, feature_new_document_list, settings_files, workspaces_beta_feature, act_read, act_delete, act_can_fire, act_can_restore_fired, act_can_block, act_can_unblock, act_edit, canChangePosition, canChangeStatus, can_see_productivity, assign_coordinators, can_edit_structure, canChangeTeam, can_edit_outcoming_config

settings Коллекция

Возможные типы:

SystemSetting

UserSetting

settingsCount integer

dateLastReadNews string

availableTransports Коллекция

Возможные типы: string

defaultReminders Коллекция

Возможные типы: DefaultReminder

defaultRemindersCount integer

nearestVacation Vacation

Ближайший отпуск сотрудника

nearestVacationsCount integer

Количество подтвержденных отпусков сотрудника в ближайшем месяце

emailFooter string

Подпись исходящих почтовый сообщений

isReadable boolean

effectiveness integer

Эффективность

description string

О себе

megaMail string

Мегапочта

appearanceDay DateTime

Дата начала работы в компании

isOnline boolean

lastOnline DateTime

canLogin boolean

fireDay DateTime

Дата увольнения

passportData string

Паспортные данные

lastAssignedTasksCount integer

Всего задач

lastClosedTasksCount integer

Закрыто задач

lastOverdueTasksCount integer

Просрочено задач

lastOverdueClosedTasksCount integer

Закрыто просроченных задач

drinking integer

Пью

smoking integer

Курю

department Department

Отдел

status EmployeeStatus

Статус В штате/Внештатник

notificationsUnreadCount integer

Количество непрочитанных сообщений

login string

Логин

password string

Пароль

behaviour string

Режим работы

hideMyBirthday boolean

Скрытвать день рождения

locale string

Локаль

timeCreated DateTime

Дата создания

googleSyncSetting GoogleSyncSetting

Настройки синхронизации с Google календарем

id string

Идентификатор

avatar File

photo File

Счет

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Invoice
invoiceDate* DateOnly

Дата документа

number string

Номер счета

name string

currency Currency

Валюта счета

sum Money

Общая сумма счета

taxTotal number

Общий налог счета

status string

Возможные варианты: created, drawn, paid, rejected

Статус счета

possibleStatuses Коллекция

Возможные типы: string

Возможные варианты: created, drawn, paid, rejected

Возможные статусы счета

possibleStatusesCount integer

Количество возможных статусов счета

comment string

Комментарий

conditions string

Условия

recipient* Payer

Получатель

payer* Payer

Плательщик

consignee* Payer

Грузополучатель

deadline DateOnly

Срок оплаты счета

userCreated Employee

Пользователь, создавший счет

actualPaymentDate DateTime

Дата и время фактической оплаты счета

rows Коллекция

Возможные типы: OfferRow

Позиции счета

rowsCount integer

Количество позиций в счете

invoiceTemplate InvoiceTemplate

Шаблон счета

publicDownloadLink string

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

financeOperations Коллекция

Возможные типы: FinOperation

Финансовые операции

financeOperationsCount integer

Количество финансовых операций

Телефония. Группа обзвона

Описание

Группа обзвона - карта маршрута звонка

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CallRoute
type string

Возможные варианты: responsible, random, all

Тип обзвона группы - ответсвенные (responsible), случайным образом (random) или всем одновременно (all)

timeout integer

Время ожидания ответа сотрудником в секундах

employees Коллекция

Возможные типы: Employee

Сущность сотрудник

users Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Список клиентов и сотрудников с указанным номером

Телефония. Звонок

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CallInfo
fromPhone string

Номер телефона абонента А (кто звонит)

toPhone string

Номер телефона абонента Б (кому звонят)

fromUser Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Пользователь абонента А

toUser Объединение
Возможные типы:
Employee

ContractorHuman

ContractorCompany

Пользователь абонента Б

providerId any

Id звонка со стороны провайдера

timeFrom DateTime

Время начала звонка

timeTo DateTime

Время завершения звонка

type string

Тип звонкаВозможные варианты: unknown, in, out, miss, fail

state string

Возможные варианты: unknown, calling, talking, finished, hold

Статус звонкаВозможны варианты: unknown, calling, talking, finished, hold

recordLinks Коллекция

Возможные типы: string

Массив ссылок на запись разговора

id string

Идентификатор

Телефония. Настройки пользователя

Описание

Пользовательские настройки телефонии

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен CallUserConfig
employee Employee

Сотрудник с интеграцией

settings string

Строка настроек (json)

internalNumber string

Внутренний номер абонента, string, можно использовать sip:number@host

id string

Идентификатор

Тип клиента

Описание
Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен ContractorType
type string

Возможные варианты: client, contact, subcontractor, partner, competitor, supplier, own, employee, guest, spam

Тип

fixedFields Коллекция

Возможные типы: string

visibleInCardFields Коллекция

Возможные типы: string

requiredFields Коллекция

Возможные типы: string

visibleOnCreationFields Коллекция

Возможные типы: string

Поля, показывающиеся при добавлении

rights ContractorTypeRights

Общие права сотрудников

responsibleRights ContractorTypeRights

Права ответственных

layoutSetting LayoutSetting

Настройка макета

layoutTabletSetting LayoutSetting

Настройка макета компактного вида

name string

Название

id string

Идентификатор

Товары

Описание

Сущность товара

Управление ресурсом

Поля сущности
Название Тип Описание Видно всегда ?
contentType string Всегда равен Offer
name* string

Название

article string

Артикул

tax Tax

НДС %

price* Money

Цена

unit Unit

Единицы измерения

quantity number

Количество

description string

Описание

originalOffer Offer

timeCreated DateTime

userCreated Employee

timeUpdated DateTime

userUpdated Employee

attaches Коллекция

Возможные типы: File

Вложения

attachesCount integer

Количество вложений

interactionsCounters Коллекция

Возможные типы: InteractionCounter

partsCount integer

Количество товаров в комплекте

parentsCount integer

Количество комплектов, в которые входит товар

parts Коллекция

Возможные типы: OfferPart

Товары в комплекте

parents Коллекция

Возможные типы: OfferPart

Комплекты, в которых есть товар

commentsWithoutTransportCount integer

Количество комментариев без транспорта

availableQuantity number

balanceQuantity number

expectedQuantity number

Ожидаемое поступление

isDropped boolean

Удален ли товар

rights OfferRights

priceWithoutTax Money

Цена без НДС

type string

Возможные варианты: product, service

warehouseBalances Коллекция

Возможные типы: WarehouseBalance

warehouseBalancesCount integer

category OfferCategory

lastComment Comment

Последний комментарий

lastCommentTimeCreated DateTime

Дата последнего комментария

nearestArrivalDate DateTime

Дата ближайшего поступления

id string

Идентификатор

isFavorite boolean

Избранная сущность или нет

avatar File

photo File

unreadCommentsCount integer

Количество непрочитанных комментариев

attachesCountInComments integer

Количество вложений в комментариях

subscribed boolean

Подписан ли текущий пользователь на комментарии по этой сущности

possibleSubscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники сущности, которые могут получать уведомления по ней.

possibleSubscribersCount integer

Количество возможных подписчиков

subscribers Коллекция

Возможные типы:

Employee

ContractorHuman

ContractorCompany

Пользователи-участники, которые подписаны на уведомления по сущности.

subscribersCount integer

Количество подписчиков

comments Коллекция

Возможные типы: Comment

Массив комментариев

commentsCount integer

Количество комментариев

hiddenCommentsCount integer

Количество скрытых комментариев

isUnread boolean

Помечен как непрочитанный

firstUnreadComment Comment

Первый непрочитанный комментарий

unreadAnswer boolean

Есть ли непрочитанный ответ или упоминание

allFiles Коллекция

Возможные типы:

File

FileGroup

Массив файлов

allFilesCount integer

Количество файлов

attachesInfo AttachesInfo

Информация о вложении