Получить информацию о компании

Возвращает подробную информацию о компании.

Формат запросаФормат запроса

GET https://api.ofd.yandex.net/{v1}/companies/{id}

• v1

  Номер версии API ОФД.

• id

  Идентификатор компании. Присваивается автоматически при регистрации компании в системе Яндекс ОФД.

Заголовок запросаЗаголовок запроса

Заголовки запроса должны содержать ключи (см. раздел Доступ к API):

Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.

Формат ответаФормат ответа

{
    "inn": "{string}",
    "kpp": "{string}",
    "ogrn": "{string}",
    "email": "{string}",
    "phone": "{string}",
    "address": "{string}",
    "short_name": "{string}",
    "full_name": "{string}",
    "manager_name": "{string}",
    "postal_code": "{string}",
    "fns": "{string}",
    "id": {number},
    "client_id": {number},
    "send_sms": {boolean},
    "send_email": {boolean}
  }

• inn

  ИНН компании. Является уникальным в рамках партнера.

• kpp

  КПП компании.

• ogrn

  ОГРН компании.

• email

  Адрес электронной почты компании.

• phone

  Телефонный номер компании.

• address

  Юридический адрес компании в формате одной строки.

• short_name

  Сокращенное название компании.

• full_name

  Полное название компании.

• manager_name

  Владелец компании.

• postal_code

  Почтовый индекс.

• fns

  Код ИФНС, в которой компания поставлена на учет.

• id

  Идентификатор компании. Присваивается автоматически при регистрации компании в системе Яндекс ОФД.

• client_id

  Идентификатор клиента, зарегистрировавшего компанию в системе Яндекс ОФД.

• send_sms

  Признак отправки чеков покупателям по SMS, если они указали номер телефона.

• send_email

  Признак отправки чеков покупателям по электронной почте, если они указали адрес.

Коды ответаКоды ответа

Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.

Пример запросаПример запроса

Метод и адрес:

GET https://api.ofd.yandex.net/v1/companies/587

Заголовки запроса:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae

curl -X GET \
  https://api.ofd.yandex.net/v1/companies/587 \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca'

Ответ:

{
    "ogrn": "5157746192731",
    "email": "mail1@example.com",
    "fns": "7705",
    "kpp": "770501001",
    "full_name": "Общество с ограниченной ответственностью ОФД-Tест",
    "id": 587,
    "address": "115035, Москва, ул Садовническая, д 82, стр 2, пом 916",
    "phone": "79111111111",
    "inn": "7704340310",
    "manager_name": "Петров Петр Петрович",
    "postal_code": "115035",
    "client_id": 88,
    "short_name": "ООО ОФД-Tест",
    "send_sms": false,
    "send_email": false
}