Изменить информацию о компании

Изменяет параметры компании в системе Яндекс ОФД.

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

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

• v1

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

• id

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

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

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

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

{
    "inn": "{string}",
    "email": "{string}",
    "phone": "{string}",
    "address": "{string}",
    "postal_code": "{string}",
    "fns": "{string}",
    "send_sms": {boolean},
    "send_email": {boolean}
  }

• inn *

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

• email *

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

• phone *

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

• address

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

• postal_code

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

• fns

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

• send_sms

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

• send_email

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

* Обязательный параметр.

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

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

{
    "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 ОФД см. в разделе Коды ответов и ошибки.

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

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

PATCH https://api.ofd.yandex.net/v1/companies/605

Заголовки:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json

Тело:

{
  "inn": "7707269841",
  "email": "mail1@example.com",
  "phone": "9175085043",
  "address": "Москва"
 }

curl -X PATCH \
  https://api.ofd.yandex.net/v1/companies/605 \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
  "inn": "7707269841",
  "email": "mail1@example.com",
  "phone": "9175085043"
  "address": "Москва"
}'

Ответ:

{
    "short_name": "ООО СуперTест",
    "full_name": "Общество с ограниченной ответственностью СуперТест",
    "manager_name": "Иванов Иван Петрович",
    "kpp": "770701001",
    "address": "Москва",
    "phone": "79175085043",
    "client_id": 88,
    "ogrn": "1027739920174",
    "fns": "7707",
    "postal_code": "",
    "email": "mail1@example.com",
    "inn": "7707269841",
    "id": 605,
    "send_sms": false,
    "send_email": false
}