Компании

Получить список компаний

Вернет список компаний, доступных авторизованному пользователю.

GET /companies

Возвращает данные:

{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Companies": [
      {
        "Address": {
          "Flat": "",
          "House": "",
          "Id": 0,
          "IdTown": 0,
          "Street": "",
          "Town": {
            "Id": 0,
            "IdRegion": 0,
            "Name": "",
            "Region": {
              "Id": 0,
              "Name": ""
            },
            "TimeZone": 0
          }
        },
        "Bin": "0001",
        "Fio": "First Company",
        "FullName": "FirstCompany",
        "Id": 20,
        "IdAddress": 0,
        "IdOwnership": 2,
        "IdUser": 1028,
        "Nds": "first address",
        "Ownership": {
          "Id": 2,
          "Name": "ТОО"
        },
        "ShortName": "FC"
      },
      ...
    ]
  }
}

Описание переменных

Название переменной	Тип переменной	Описание переменной
Companies	array	Объект с компаниями
Address	object	Объект с информацией об адресе компании
Flat	string	Этаж/квартира, где расположена компания
House	string	Дом, в котором расположена компания
Id	int	Идентификатор адреса
IdTown	int	Идентификатор города
Street	string	Название улицы
Town	object	Объект с информацией о городе
Id	int	Идентификатор города
IdRegion	int	Идентификатор региона
Name	string	Название идентификатора города
Region	object	Объект с информацией о регионе
Id	int	Идентификатор региона
Name	string	Название идентификатора региона
TimeZone	int	Часовой пояс
Bin	string	Бизнес-идентификационный номер
Fio	string	Фамилия, имя, отчество
FullName	string	Полное название компании
Id	int	Идентификатор компании
IdAddress	int	Идентификатор адреса
IdOwnership	int	Идентификатор формы юридического лица
IdUser	int	Идентификатор пользователя
Nds	string	Номер свидетельства о постановке на учет по ндс
Ownership	object	Формы юридического лица
Id	int	Идентификатор формы юридического лица
Name	string	Название формы юридического лица
ShortName	string	Сокращенное название компании
IdShift	int	Идентификатор открытой смены или последней открытой смены

Описание значения поля Ownership

"Ownership": {"Id": 2, "Name": "ТОО"}

Значение статуса	Описание статуса
{"Id": 1, "Name": "ИП"}	Индивидуальный предприниматель
{"Id": 2, "Name": "ТОО"}	Товарищество с ограниченной ответственностью

Если пользователь не зарегистрирован ни в одной компании, то вернется пустой массив компаний:

{
  "Status": 200,
  "Message": "OK",
  "Data": {
    "Companies": [ object ]
  }
}

Ошибки

Status	Message	Способ устранения
401	Unauthorized: token is expired by 2h36m46s	Получить новый токен
500	Internal Server Error	Обратиться в тех. поддержку

Блок-схема