Компании
- Anton Sukhorukov
Analytics
Получение списка компаний
Описание: Позволяет получить информацию по всем компаниям ТСП
Адрес: https://api.cloudtips.ru/api/companies
Тип: GET
Запрос:
Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
createdDateFrom | Datetime | Нет | Поиск по дате создания с |
createdDateTo | Datetime | Нет | Поиск по дате создания по |
name | String | Нет | Поиск по названию (может быть частичным) |
ids | Array of string | Нет | Поиск по уникальному идентификатору компании |
page | Integer | Нет | номер страницы |
limit | Integer | Нет | Ограничение на количество записей |
Пример запроса:
{
"createdDateFrom": "string",
"createdDateTo": "string",
"name": "string",
"ids": [
"string"
],
"page": "integer",
"limit": "integer"
}
Ответ:
Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
id | String | Да | Уникальный идентификатор компании |
name | String | Да | Имя компании |
managerId | String | Да | Идентификатор ответственного менеджера |
legalName | Boolean | Да | Юридическое название компании |
legalAddress | Integer | Да | Юридический адрес компании |
inn | String | Да | ИНН компании |
totalCount | Integer | Да | Количество записей |
succeed | String | Да | Признак успешности запроса |
errors | Array of string | Да | Возвращатеся список ошибок, относящихся целиком к запросу |
validationErrors | Array of string | Да | Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса |
Пример ответа:
{
"data": {
"items": [
{
"id": "string",
"name": "string",
"manager": {
"managerId": "string",
"name": "string"
},
"legalName": "string",
"legalAddress": "string",
"inn": "string"
}
],
"totalCount": 0
},
"succeed": true,
"errors": [
"string"
],
"validationErrors": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
}
}Создание компании
Описание: Создание компании
Адрес: https://api.cloudtips.ru/api/companies
Тип: POST
Запрос:
Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
name | String | Да | Имя компании |
inn | String | Да | ИНН компании |
placeAdministratorIds | Array of string | Нет | Администраторы заведения |
externalInfo.id | string | Нет | Внешний идентификатор компании |
Пример запроса:
{
"name": "string",
"inn": "string",
"placeAdministratorIds": [
"string"
],
"externalInfo": {
"id": "string"
}
}
Ответ:
Наименование | Тип | Обязательность | Описание |
|---|---|---|---|
id | String | Да | Уникальный идентификатор компании |
succeed | String | Да | Признак успешности запроса |
errors | Array of string | Да | Возвращатеся список ошибок, относящихся целиком к запросу |
validationErrors | Array of string | Да | Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса |
Пример ответа:
{
"data": {
"id": "string"
},
"succeed": true,
"errors": [
"string"
],
"validationErrors": {
"additionalProp1": [
"string"
],
"additionalProp2": [
"string"
],
"additionalProp3": [
"string"
]
}
}