Получить список компаний
Внимание
Новые ключи временно не выпускаются в связи с обновлением продукта.
Возвращает список компаний.
Формат запроса
GET https://api.ofd.yandex.net/{v1}/companies
? [inn=<string>]
& [kpp=<string>]
& [ogrn=<string>]
& [client_id=<string>]
& [limit=<integer>]
& [offset=<integer>]
Номер версии API ОФД.
ИНН компании.
КПП компании.
ОГРН компании.
Идентификатор клиента, зарегистрировавшего компанию в системе Яндекс ОФД.
Максимальное количество объектов, возвращаемое в ответе.
Смещение от начала списка объектов.
-
- v1
- Номер версии API ОФД.
-
- inn
- ИНН компании.
-
- kpp
- КПП компании.
-
- ogrn
- ОГРН компании.
-
- client_id
- Идентификатор клиента, зарегистрировавшего компанию в системе Яндекс ОФД.
-
- limit
- Максимальное количество объектов, возвращаемое в ответе.
-
- offset
- Смещение от начала списка объектов.
Заголовок запроса
Заголовки запроса должны содержать ключи (см. раздел Доступ к API):
| Заголовок | Значение |
|---|---|
X-Yandex-Key |
<аутентификационный ключ> |
X-OFD-Key |
<авторизационный ключ> |
Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.
Формат ответа
[
{
"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
- ОГРН компании.
-
- Адрес электронной почты компании.
-
- 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
Заголовки запроса:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Пример запроса в формате cURL
curl -X GET \
https://api.ofd.yandex.net/v1/companies \
-H 'x-ofd-key: eka...b17eae' \
-H 'x-yandex-key: 74f...e8ca'
Ответ:
[
{
"short_name": "ООО ОФД-Tест",
"full_name": "Общество с ограниченной ответственностью ОФД-Tест",
"manager_name": "Петров Петр Петрович",
"kpp": "770501001",
"address": "115035, Москва, ул Садовническая, д 82, стр 2, пом 916",
"phone": "79111111111",
"client_id": 88,
"ogrn": "5157746192731",
"fns": "7705",
"postal_code": "115035",
"email": "mail1@example.com",
"inn": "7704340310",
"id": 587,
"send_sms": false,
"send_email": false
},
{
"short_name": "ООО Tест",
"full_name": "Общество с ограниченной ответственностью Тест",
"manager_name": "Иванов Иван Иванович",
"kpp": "402801001",
"address": "Калужская обл., 248021, Калуга, ул Поле Свободы, д 129, к а",
"phone": "70123456789",
"client_id": 88,
"ogrn": "1134028000600",
"fns": "4028",
"postal_code": "248021",
"email": "mail1@example.com",
"inn": "4028053514",
"id": 601,
"send_sms": false,
"send_email": false
}
]